-
Task
-
Resolution: Done
-
Undefined
-
None
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:
1. - [X] Mandatory Add the required version to the Fix version/s field.
2. - [X] Mandatory Choose the type of documentation change.
- [X] New topic in an existing section or new section
- [ ] Update to an existing topic
New content for Global Hub. Will currently be in the upstream, but will need to go into the Portal at some point. There is a discussion about where in the Portal it will go. ACM docs? Their own docs?
For the tech preview of the Global Hub Compliance Policy View. The customer can follow the document to install the global hub on the disconnected environment and know what features are delivered and how to use them.
The global hub upstream is located here: https://github.com/stolostron/multicluster-global-hub/tree/main/doc If you find any thing you need to updated, you can start a pull request. Thanks!
3. - [X] Mandatory for GA content:
- [ ] Add steps and/or other important conceptual information here:
- [ ] 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?)
- [X] Add link to dev story here: Linked to epic: https://issues.redhat.com/browse/ACM-2683
4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:
============================================
Value Statement
Ensure the issue title clearly reflects the value of this user story to the
intended persona. (Explain the "WHY")
For the tech preview of the Global Hub Compliance Policy View. The customer can follow the document to install the global hub on the disconnected environment and know what features are delivered and how to use them.
Definition of Done for Engineering Story Owner (Checklist)
The global hub upstream is located here: https://github.com/stolostron/multicluster-global-hub/tree/main/doc If you find any thing you need to updated, you can start a pull request. Thanks!
Development Complete
- The code is complete.
- Functionality is working.
- Any required downstream Docker file changes are made.
Secure Design
- [ ] Security has been assessed and incorporated into your threat model.
Multidisciplinary Teams Readiness
- [ ] Create an informative documentation issue using the [Customer
Portal_doc_issue template](
https://github.com/stolostron/backlog/issues/new?assignees=&labels=squad%3Adoc&template=doc_issue.md&title=),
and ensure doc acceptance criteria is met. Link the development issue to
the doc issue. - [ ] Provide input to the QE team, and ensure QE acceptance criteria
(established between story owner and QE focal) are met.
Support Readiness
- [ ] The must-gather script has been updated.