Continuous release numbering#505
Conversation
update of the version extension numbering text and example
correction of consecutive numbering example
update text on continuous version extension numbering
tanjadegroot
requested review from
PedroDiez,
jlurien,
patrice-conil,
rartych and
shilpa-padgaonkar
as code owners
|
@camaraproject/release-management_maintainers please review this proposed update. |
|
@tanjadegroot The changes improve the documentation’s alignment with industry best practices for API versioning, especially avoiding version-related ambiguity in URLs. I am just wondering if makig the table instead of the list in lines 1153-54 would be easier to read like this:
Markdown is always emphasizing the first row as the table header , then it can be table like this (but I like the compact view as above):
WDYT? |
@rartych I like your idea on the horizontal table - I also prefer that one over the vertical one which reflect less the lifecycle evolution over time. - I have included your proposal in the branch :-) I also updated the Confluence where I added the same for initial APIs - see https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14557919/API+versioning |
patrice-conil
left a comment
patrice-conil
left a comment
There was a problem hiding this comment.
Nice clarification
LGTM
4 participants
What type of PR is this?
What this PR does / why we need it:
Update the text on continuous version extension numbering for more clarity
Which issue(s) this PR fixes:
Fixes #504
Does this PR introduce a breaking change?
Special notes for reviewers:
See also on Wiki: https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14557919/API+versioning