Docs changes in WGE install guide, cluster mgmt pages#3919
Closed
lasomethingsomething wants to merge 38 commits intomainfrom
Closed
Docs changes in WGE install guide, cluster mgmt pages#3919lasomethingsomething wants to merge 38 commits intomainfrom
lasomethingsomething wants to merge 38 commits intomainfrom
Conversation
added 30 commits
August 7, 2023 10:37
lasomethingsomething
added
user-guide
Contributor
Author
|
Partly fixes #3886 |
Contributor
|
@LappleApple why the PR does not uses the PR template ? I find it useful in particular for reviewers to frame the change: For example, in PR description says
But does no provides context on the current issue of user discovery and how this enhances that situation. |
Contributor
Author
|
@enekofb Addressed comment |
enekofb
reviewed
Aug 15, 2023
Contributor
There was a problem hiding this comment.
It seems that CI docs job fails
Tried to run it locally with the same issue
➜ website git:(docs-changes-aug7) GA_KEY=fakekey yarn start
[INFO] Starting the development server...
[ERROR] Loading of version failed for version current
[ERROR] Error: Invalid sidebar file at "sidebars.js".You could follow dev docs instructions to test it in your environment
Contributor
Author
|
@enekofb I typically do that, and did so before filing this, but we've made changes since then. I'll run again tomorrow. |
Contributor
Author
|
Closing in favor of #3955. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes
What changed?
Folds a number of pages into the install WGE guide for user discovery. Addresses link changes in current and v0.29.0 versions. Addresses feedback from CX and Engineering related to missing or inaccurate information in some cluster mgmt pages.
Why was this change made?
To fix errors, gaps, and other docs issues
How was this change implemented?
Substantial changes triggered by feedback from Sales and other internal parties about issues using the user docs. Gets rid of the current "Access Configuration" section in order to fold pages and content into the installation guide where users are more likely to expect and seek them.
How did you validate the change?
Ran npm run build to fix broken links
Release notes
Fixes errors and gaps in release guide Cluster Management and WGE Install guide
Documentation Changes
The PR is a doc change