Closed tanjadegroot closed 2 weeks ago
I have discovered that in Commonalities we have https://github.com/camaraproject/Commonalities/blob/main/documentation/Camara_Versioning_Guidelines.md I think it should be deprecated with redirection to the proposed here API Design Guidelines and Release Management documentation. To speed up things maybe we can do it within this PR. @tanjadegroot @hdamker ?
Hi Rafal, yes that is correct. this file can be deprecated. API versioning is now going into the API Guidelines section 5 API release process is now here: https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API_Release_Guidelines.md (with more details in the CAMARA release Management Wiki)
Tanja, if you could modify the file in Nokia fork: https://github.com/nokia/camaraproject-Commonalities/blob/Update-versioning-section-in-API-design-guidelines/documentation/Camara_Versioning_Guidelines.md then we go with all the changes within this PR.
@hdamker to check this update
Tanja, if you could modify the file in Nokia fork: https://github.com/nokia/camaraproject-Commonalities/blob/Update-versioning-section-in-API-design-guidelines/documentation/Camara_Versioning_Guidelines.md then we go with all the changes within this PR.
I just need to remove the file corrrect ?
I just need to remove the file corrrect ?
@tanjadegroot that's not enough, also the line in the table within https://github.com/camaraproject/Commonalities/blob/main/README.md need to be updated/replaced.
What about deleting the two lines about API-Readiness-Checklist.md and Camara_Versioning_Guidelines.md
and put underneath the table something like:
NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-Checklist, are now located within [ReleaseManagement](https://github.com/camaraproject/ReleaseManagement). The versioning of API is defined within API-design-guidelines.md](documentation/API-design-guidelines.md#5-versioning).
@rartych WDYT about the README?
README.md update done
@patrice-conil Could you approve it?
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
It updates the versioning section to be in line with the API versioning for the release management process
Which issue(s) this PR fixes:
Fixes #206
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.