Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-13654

Improve observability structure/TOC Part 1

XMLWordPrintable

    • 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. - [x] Mandatory: Choose the type of documentation change or review.

      • [x] We need to update to an existing topic
      • [ ] 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:

      4. - [ ] Mandatory for GA content:

      • [s] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:

      Reorganize some of the TOC and improve the content structure of the current doc.
      Link to the draft that samukher@redhat.com created: https://docs.google.com/document/d/1qrYULHG9-V93tkKBAPVXQSMc2Ce7B9VSl7tmUZM6baE/edit 
      Link to Mj attempt: https://docs.google.com/document/d/1p8tHZt1n3ftEgWbTRgYjhjMkWWesS0Y15l6aQFxoZGo/edit 

      No PR yet bc I have alot of them open, but will have a live review soon.

      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] 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:

      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.

              mdockery@redhat.com Mikela Jackson
              mdockery@redhat.com Mikela Jackson
              Christian Stark, Moad Zardab, Saswata Mukherjee
              Xiang Yin Xiang Yin
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: