Automation script to generate new docs version #540
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kfirtoledo
approved these changes
Apr 30, 2024
|
As we discussed need to open an issue for the manual steps. |
Signed-off-by: Etai Lev Ran <elevran@gmail.com>
- TODO: order params.versions correctly (main, new version, previous version, ...) Signed-off-by: Etai Lev Ran <elevran@gmail.com>
Signed-off-by: Etai Lev Ran <elevran@gmail.com>
elevran
force-pushed
the
feat/generate-doc-version
branch
from
eac2061 to
c3eeaee
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Automate the creation of a new documentation version.
Process is documented and implemented in
hack/gen-doc-version.shNeeds improvement:
param.versionsarray correctly (main, new version, previous version, ...) -sedseems limited for this and go-toml packages do not handle comments ;-( Maybe awk or perl could be used or maybe we use Go for all (useospackage o run git, https://github.com/adrg/frontmatter for frontmatter, etc.) and clean up comments from the file?docs/${NEW_DOCS_VERSION}/_index,mdfile's frontmatterFixes #531