Create an informative issue (See each section, incomplete templates/issues won't be triaged)
Using the current documentation as a model, please complete the issue template.
Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.
Prerequisite: Start with what we have
Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:
- Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes
- Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
Describe the changes in the doc and link to your dev story
Provide info for the following steps:
- - [X] Mandatory Add the required version to the Fix version/s field.
The docs for ACM 2.6-2.8 need the must-gather command altered
2. - [X] Mandatory Choose the type of documentation change.
- [ ] New topic in an existing section or new section
- [X] Update to an existing topic
3. - [ ] Mandatory for GA content:
- [ ] Add steps and/or other important conceptual information here:
The commands for the 3 version of the must-gather need the .0 removed from the version.
Here for 2.6
https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.6/html/troubleshooting/troubleshooting#running-the-must-gather-command-to-troubleshoot:~:text=oc%20adm%20must%2Dgather%20%2D%2Dimage%3Dregistry.redhat.io/rhacm2/acm%2Dmust%2Dgather%2Drhel8%3Av2.6.0%20%2D%2Ddest%2Ddir%3D%3Cdirectory%3E
The command should be:
oc adm must-gather --image=registry.redhat.io/rhacm2/acm-must-gather-rhel8:v2.6 --dest-dir=<directory>
oc adm must-gather --image=registry.redhat.io/rhacm2/acm-must-gather-rhel8:v2.7 --dest-dir=<directory
oc adm must-gather --image=registry.redhat.io/rhacm2/acm-must-gather-rhel8:v2.8 --dest-dir=<directory>
The same needs to be done for the multicluster-engine must-gather command.
In the ACM 2.7 docs:
https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#running-the-must-gather-command-to-troubleshoot-mce:~:text=oc%20adm%20must%2Dgather%20%2D%2Dimage%3Dregistry.redhat.io/multicluster%2Dengine/must%2Dgather%2Drhel8%3Av2.2.0%20%2D%2Ddest%2Ddir%3D%3Cdirectory%3E
The command should be:
oc adm must-gather --image=registry.redhat.io/multicluster-engine/must-gather-rhel8:v2.2 --dest-dir=<directory>
oc adm must-gather --image=registry.redhat.io/multicluster-engine/must-gather-rhel8:v2.3 --dest-dir=<directory>
- [ ] Add Required access level for the user to complete the task here:
- [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
- [ ] Add link to dev story here:
4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation: