-
Notifications
You must be signed in to change notification settings - Fork 769
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
add versioned docs #1645
add versioned docs #1645
Conversation
Signed-off-by: Sertac Ozercan <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #1645 +/- ##
==========================================
- Coverage 52.81% 52.54% -0.27%
==========================================
Files 98 98
Lines 8591 8591
==========================================
- Hits 4537 4514 -23
- Misses 3695 3715 +20
- Partials 359 362 +3
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Signed-off-by: Sertac Ozercan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you for doing this!
docs/RELEASE.md
Outdated
@@ -56,9 +56,16 @@ Cherry pick script is copied over from https://github.com/kubernetes/kubernetes/ | |||
make promote-staging-manifest | |||
``` | |||
|
|||
1. If it's a new minor release (e.g. v3.7.0), tag docs to be versioned. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit, use a before and after if you want to clarify (v3.6.x -> 3.7.0
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@maxsmythe thoughts on if we should call NEWVERSION
v3.7.0
or v3.7.x
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.x makes sense since ideally all patch versions shouldn't have behavior changes and it's more clear that it applies to all
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm okay with either. Usually a new minor version starts at patch zero, but keeping x for both is clearer.
Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: Sertac Ozercan [email protected]
What this PR does / why we need it:
make version-docs NEWVERSION=v3.7.x
), see updated release docexample: https://sozercan.github.io/gatekeeper/website/docs/ (see upper right)
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when the PR gets merged):Fixes #1185
Special notes for your reviewer: