search

camaraproject / Governance

Telco network capabilities exposed through APIs provide a large benefit for customers. By simplifying telco network complexity with APIs and making the APIs available across telco networks and countries, CAMARA enables easy and seamless access.
53 stars 44 forks source link

Update of README.md structure in all sub projects #124

Open hdamker opened 2 months ago

hdamker commented 2 months ago

To improve the structure to project and working group information, and to make the information within the README.md files consistent and reusable within the wiki and website, there is currently an update of the README.md within the repo template proposed by the LF team: https://github.com/camaraproject/Template_Lead_Repository/pull/3

As soon as this PR is merged into the repo template we also have to make sure that all existing repos (README files) are updated to the same structure (and also all the website pages). The new README.md files will also be used as the base information within the sub project wiki pages (see here for an example).

Update: Checklist of all repositories, to track the progress of this issue (can btw be copied also into other similar issues):

Working Groups

(API) Sub Projects

hdamker commented 2 months ago

@wrathwolf Could you check of above the ones which are already done and support the remaining ones to get there?

For each Sub Project:

AxelNennker commented 1 month ago

My comment on the PR was in the wrong place, sorry for that. Maybe the comment is more fitting here:

I think the scope section in the template is not fitting any working group.

´´´ Service APIs for “§repo_name§” (see APIBacklog.md) It provides the customer with the ability to:

§API (family) description§.

:

NOTE: The scope of this API family should be limited (at least at the first stage) to 4G and 5G.

Describe, develop, document, and test the APIs ´´´

I can't think of a template-text for "Scope" that fits all working groups.

Can we have a template like this?:

§repo_name§

Repository to describe, develop, document, and test the §repo_name§ API family

Scope

§scope§

start_date is moved up. The content of §scope§ is defined somewhere else?

I do not know enough about the template process to make suggestions that are reasonable. Or we fill-in the "scope" for working groups manually.

hdamker commented 1 month ago

@AxelNennker I created an issue within the Template Repository for that. It's only since we moved the working groups out of "WorkingsGroups" repo that the template is also used for working groups. Solution will be to mark clearly that the scope section has to be adapted within the Sub Project. The §scope§ is coming from the agreement within APIBacklog.