-
Task
-
Resolution: Unresolved
-
Normal
-
None
-
False
-
None
-
False
-
-
-
None
Note: Doc team updates the current version of the documentation and the
two previous versions (n-2), but we address *only high-priority, or
customer-reported issues* for -2 releases in support.
Describe the changes in the doc and link to your dev story:
1. - [X] Mandatory: Add the required version to the Fix version/s field.
2. - [ ] Mandatory: Choose the type of documentation change or review.
- [ ] We need to update to an existing topic
- [X] We need to add a new document to an existing section
- [ ] We need a whole new section; this is a function not
documented before and doesn't belong in any current section
- [ ] We need an Operator Advisory review and approval
- [ ] We need a z-Stream (Errata) Advisory and Release note
for MCE and/or ACM
3. - [ ] *Mandatory: *Use the following link to open the doc and find where the
documentation update should go. Note: As the feature and doc is
understood and developed, this placement decision may change:
- Published doc: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/web_console/web-console
- The feature adds more options to the web console to access observability metrics in RHACM as well as links to OpenShift Virtualization directly in managed OCPs. It may require a new topic or simply updates. I think it's the former.
- Source: https://github.com/stolostron/rhacm-docs/blob/2.13_stage/console/main.adoc
4. - [X] Mandatory for GA content:
- [ ] Add steps, the diff, known issue, and/or other important
conceptual information in the following space:
The goal of this docs issue is to allow the main web console docs to be updated to reflect changes made in https://issues.redhat.com/browse/ACM-16138 - These relate specifically to making it easier for admins to find VM metrics in RHACM and on OCP Virt consoles. So we will need some updates to reflect the UX changes. The main goal is it makes using the RHACM web console to find VM metrics more easy. And ultimately helps customers avoid needing to jump from tool to tool and rather focus on using RHACM. Would be great to reflect this in the docs (I am happy to work together on shaping what that means ).
- [X] *Add Required access level *(example, *Cluster
Administrator*) for the user to complete the task:
User and admin
- [ ] Add verification at the end of the task, how does the user
verify success (a command to run or a result to see?)
Docs accurately reflect both the functional navigational elements as well as convey the intent behind their existence.
- [ ] Add link to dev story here:
5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
problem is, what the change is, and link to the current documentation. Only
use this for a documentation bug.
- documents
-
ACM-16138 As a VM user, I want a link to relevant observability metrics dashboard
-
- Closed
-