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

Observability doc topic :: improve the sub-topic organization

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • Low
    • No

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/observability/index

      1. In the Observability TOC, item 1.2.3 is actually a sub topic of 1.2.2. So it should become 1.2.2.3.
      2. Then, the 1.2.3.1 and 1.2.3.2, these are more about 'Using Observability' and less about 'Enabling observability service'. So should we consider creating a new high level topic about 'Using' ? 1.3 Using Observability / 1.4 Customizing... / 1.5 Obs Alerts...
      3. Inside of 1.2.2, there are a slew of issues, namely that it is way too many steps without a sub-topic header and you can easily get lost and confused. There are also various steps about AWS STS enablement in there, but not concise defined in a set. this makes it hard to find as it is only sub-bullets. I think we're also missing GCP WIF topic which is a feature added in 2.7 I think.
        1. the 1.2.2.1. Verifying the Thanos version - you cannot do this until it has been deployed, so perhaps it should move to a final step of the Enable section
      4. 1.2.4 I think it should be Removing observability- notice that there is also 1.3.8 about Disable Observability which I think it is a real 'disable' topic.

              mdockery@redhat.com Mikela Jackson
              sberens@redhat.com Scott Berens
              Scott Berens Scott Berens
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: