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.

Sign up for GitHub

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

Jump to bottom

Update versioning section in api design guidelines #215

Merged
merged 15 commits into from
Jun 19, 2024
Merged

Update versioning section in api design guidelines #215

merged 15 commits into from
Jun 19, 2024

Conversation

tanjadegroot
Copy link
Contributor

What type of PR is this?

Add one of the following kinds:

  • documentation

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

 release-note: update the API versioning in line with the release management process

Additional documentation

This section can be blank.

docs

@rartych rartych mentioned this pull request May 27, 2024
Closed
@shilpa-padgaonkar shilpa-padgaonkar mentioned this pull request May 29, 2024
Closed
@rartych rartych requested a review from hdamker June 3, 2024 12:12
hdamker
hdamker reviewed Jun 11, 2024
View reviewed changes
Copy link
Collaborator

@hdamker hdamker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. One proposal and one question below.

tanjadegroot and others added 2 commits June 11, 2024 17:22
@tanjadegroot @hdamker
Update documentation/API-design-guidelines.md
8e2c4e6 
Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>
@tanjadegroot
Update API-design-guidelines.md
633bc14 
Update following comments on backward compatibility section
hdamker
hdamker previously approved these changes Jun 12, 2024
View reviewed changes
@hdamker hdamker requested a review from a team June 12, 2024 06:59
@rartych
Copy link
Contributor

rartych commented Jun 12, 2024

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 ?

@tanjadegroot
Copy link
Contributor Author

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)

@rartych
Copy link
Contributor

rartych commented Jun 12, 2024

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.

@tanjadegroot
Update API-design-guidelines.md - removing release aspects
f1ef812 
Changed the use of "public-release" to just "public" 
Removed references to release aspects for the versioning section
@tanjadegroot
Copy link
Contributor Author

@hdamker to check this update

@tanjadegroot
Copy link
Contributor Author

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 ?

@tanjadegroot
Delete documentation/Camara_Versioning_Guidelines.md
50bc2f7 
release mgmt information is moved to the Release Mgmt repo
@hdamker
Copy link
Collaborator

hdamker commented Jun 12, 2024 •
edited
Loading

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?

@tanjadegroot
Update API-design-guidelines.md
b817b7d 
complement to removing release info from versioning section
@tanjadegroot
Update README.md
528f320 
removed the references to 2 removed documents and added note to point to ReleaseManagement repo
@tanjadegroot
Copy link
Contributor Author

tanjadegroot commented Jun 12, 2024 •
edited
Loading

README.md update done

hdamker
hdamker previously approved these changes Jun 12, 2024
View reviewed changes
@tanjadegroot
Update API-design-guidelines.md
85ceb7a 
Shilpa's comment on URL version
@tanjadegroot
Update API-design-guidelines.md
8f1ffc6 
included updates on removing"-" in release names
some more tweeks
rartych
rartych previously approved these changes Jun 14, 2024
View reviewed changes
Copy link
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

patrice-conil
patrice-conil previously approved these changes Jun 14, 2024
View reviewed changes
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/LGTM

hdamker
hdamker previously approved these changes Jun 14, 2024
View reviewed changes
shilpa-padgaonkar
shilpa-padgaonkar previously approved these changes Jun 14, 2024
View reviewed changes
Copy link
Contributor

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/LGTM

@tanjadegroot @PedroDiez
Update documentation/API-design-guidelines.md
0556740 
fix typo

Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
PedroDiez
PedroDiez approved these changes Jun 17, 2024
View reviewed changes
Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

shilpa-padgaonkar
shilpa-padgaonkar approved these changes Jun 18, 2024
View reviewed changes
Copy link
Contributor

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/LGTM

@rartych
Copy link
Contributor

rartych commented Jun 19, 2024

@patrice-conil Could you approve it?

patrice-conil
patrice-conil approved these changes Jun 19, 2024
View reviewed changes
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych merged commit 76e386c into camaraproject:main Jun 19, 2024
@rartych rartych mentioned this pull request Jul 31, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PedroDiez PedroDiez PedroDiez approved these changes

@patrice-conil patrice-conil patrice-conil approved these changes

@hdamker hdamker hdamker approved these changes

@shilpa-padgaonkar shilpa-padgaonkar shilpa-padgaonkar approved these changes

@rartych rartych rartych approved these changes

@RubenBG7 RubenBG7 Awaiting requested review from RubenBG7

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update of API versioning section in API guidelines
6 participants
@tanjadegroot @rartych @hdamker @PedroDiez @patrice-conil @shilpa-padgaonkar