adding workflow for major release doc updates #4000
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
Signed-off-by: anaxceron <[email protected]>
anaxceron
added
area: docs
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these steps.
|
1 similar comment
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these steps.
|
zFernand0
approved these changes
Nov 15, 2024
Comment on lines
+37
to
+40
| - Archive the `/static` files: | ||
| 1. Go to the `/static` folder. | ||
| 2. Create an empty directory with the name of the previous version in `/static`. For example: `static/v3.5.x`. | ||
| 3. Copy all contents of the `/static/stable` directory and paste them in the previous version's empty directory in the previous step. For example: `/static/v3.5.x`. |
There was a problem hiding this comment.
Would it be possible to have these steps be done as part of the npm run <script> mentioned above?
There was a problem hiding this comment.
Idk, but if so, we'd need dev help to look into, and implement, that.
| 2. Create an empty directory with the name of the previous version in `/static`. For example: `static/v3.5.x`. | ||
| 3. Copy all contents of the `/static/stable` directory and paste them in the previous version's empty directory in the previous step. For example: `/static/v3.5.x`. | ||
|
|
||
| - Update a set of links in the archived documentation to ensure that they refer to the correct location: |
There was a problem hiding this comment.
Is there a way to run the link checker locally?
That way we don't have to rely on manual link-verification 😋
There was a problem hiding this comment.
It can be run locally, but would require installing extra deps like Rust/cargo.
cargo install lychee
lychee --accept 403,406,429 --cache --fallback-extensions md --include-fragments --max-cache-age 1d --max-concurrency 2 --timeout 60 --verbose 'docs/**/*.md'|
|
||
| 1. To do this, switch to the archived directory. In our example, that's `versioned_docs/version-v3.5.x`. | ||
|
|
||
| 2. Update several locations in the archived docs to refer to the correct release, the 3.5 release (in our example case). |
There was a problem hiding this comment.
it sounds like these steps could also be moved into a script? 😋
t1m0thyj
approved these changes
Nov 15, 2024
There was a problem hiding this comment.
LGTM, thanks @anaxceron - I don't have any comments to add to Fernando's 😋
Signed-off-by: anaxceron <[email protected]>
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.
Describe your pull request here: Documenting the process for updating doc for a major Zowe release
List the file(s) included in this PR: major_release_workflow.md
After creating the PR, follow the instructions in the comments.