Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a user-friendly snapshot for CAMARA users and developers #100

Open
2 of 3 tasks
hdamker opened this issue Oct 15, 2023 · 5 comments
Open
2 of 3 tasks

Provide a user-friendly snapshot for CAMARA users and developers #100

hdamker opened this issue Oct 15, 2023 · 5 comments
Labels
project management Work to be done for the project

Comments

@hdamker
Copy link
Collaborator

hdamker commented Oct 15, 2023

With the upcoming wiki.camaraproject.org we will get the opportunity to provide an overview across the CAMARA (sub) projects which is more user friendly and easier to maintain than the current APIBacklog.md.

Next steps (proposed by @jordonezlucena):

This issue replaces camaraproject/WorkingGroups#307

jordonezlucena added a commit to camaraproject/WorkingGroups that referenced this issue Oct 26, 2023
API backlog cleaned-up, following [#100](camaraproject/Governance#100)
@jordonezlucena
Copy link
Contributor

jordonezlucena commented Oct 26, 2023

Update current APIBacklog.md with information from AHC(@jordonezlucena)

Actioned through #331

@jordonezlucena
Copy link
Contributor

@hdamker @MarkusKuemmerle: what is the status of the second step (Wait for wiki.camaraproject.org being operational)?

@hdamker
Copy link
Collaborator Author

hdamker commented Nov 16, 2023

@jordonezlucena wiki.camaraproject.org can in principle be used (we already use it for TSC meeting minutes). We just need to decide on which level we place the information and address the third task.

@hdamker hdamker added TSC Issue to be handled by TSC project management Work to be done for the project labels Nov 16, 2023
@jordonezlucena
Copy link
Contributor

@jordonezlucena wiki.camaraproject.org can in principle be used (we already use it for TSC meeting minutes). We just need to decide on which level we place the information and address the third task.

@hdamker: as noted in the latest commit at #331, the proposal is to remove from APIbacklog table all the information related to actual API lifecycle management. This includes the following fields:

  • API release: the list of versions of the API. Version follows the x.y.z conventionE.
  • Link to API definition: (for a given API release) it specifies a pointer to the API definition.
  • Link to API documentation: (for a given API release) it specifies a pointer to the API definition.
  • Link to API code: (for a given API release) it specifies a pointer to the API YAML file
  • API tested at: (for a given API release) list of operators which have tested the API functioning and behaviour.
  • API deployed at company and country: (for a given API release) list of operators which have deployed API, and in which countries.

The reason is that these SIX fields capture information which is in scope and under supervision of corresponding Sub-Projects, and thus difficult for Backlog WG to maintain and evolve (and even more in a .md file).

Whether it makes sense for wiki.camaraproject.org to host all these fields, or only a subset of them, it is a decision I prefer to leave to TSC.

@jordonezlucena
Copy link
Contributor

@jordonezlucena wiki.camaraproject.org can in principle be used (we already use it for TSC meeting minutes). We just need to decide on which level we place the information and address the third task.

@hdamker: as noted in the latest commit at #331, the proposal is to remove from APIbacklog table all the information related to actual API lifecycle management. This includes the following fields:

  • API release: the list of versions of the API. Version follows the x.y.z conventionE.
  • Link to API definition: (for a given API release) it specifies a pointer to the API definition.
  • Link to API documentation: (for a given API release) it specifies a pointer to the API definition.
  • Link to API code: (for a given API release) it specifies a pointer to the API YAML file
  • API tested at: (for a given API release) list of operators which have tested the API functioning and behaviour.
  • API deployed at company and country: (for a given API release) list of operators which have deployed API, and in which countries.

The reason is that these SIX fields capture information which is in scope and under supervision of corresponding Sub-Projects, and thus difficult for Backlog WG to maintain and evolve (and even more in a .md file).

Whether it makes sense for wiki.camaraproject.org to host all these fields, or only a subset of them, it is a decision I prefer to leave to TSC.

New PR available in #360

@hdamker hdamker removed the TSC Issue to be handled by TSC label Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project management Work to be done for the project
Projects
None yet
Development

No branches or pull requests

2 participants