-
Notifications
You must be signed in to change notification settings - Fork 69
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
docs: add versioned docs #20
docs: add versioned docs #20
Conversation
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.
Just questions for my understanding:
-
Should we be using the
v?.?.x
versioning name? It looks like once Docusaurus spits out a versioned copy, those are expected to be frozen. If we only want to publish doc versions per minor update, then it feels like we should just dov?.?
, which leaves open the possibility that we may publishv?.?.?
revision to correct something particularly egregious in the minor version of the docs. -
Is the intention that the docusaurus versions are locked against the release versions? Just thinking about whether we should integrate the doc versioning with the release automation.
+1 on adding to release automation |
@sozercan how does Eraser do the release automation? I couldn't find anything in the repo that looked like it tied the docs to newly released versions via automation |
@salaxander it is defined here: https://github.com/Azure/eraser/blob/main/.github/workflows/release-pr.yaml#L69 it's part of initial release pr generation. https://github.com/Azure/eraser/blob/main/Makefile#L301 |
21b3816
to
e37f477
Compare
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #20 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 27 27
=========================================
Hits 27 27 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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.
Looks generally good to me, thanks for adding the automation in - see comment about the v0.1.x version though.
Signed-off-by: Xander Grzywinski <[email protected]>
e37f477
to
c67ddcb
Compare
Signed-off-by: Xander Grzywinski <[email protected]>
c67ddcb
to
419bb11
Compare
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, thanks!
Signed-off-by: Xander Grzywinski <[email protected]>
Signed-off-by: Xander Grzywinski [email protected]
Add versioned docs starting with
v0.1.x
Closes #15