Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-1376

Missing sections in Logging 6 documentation and problems with the structure and content

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • Logging 6.0
    • Logging
    • False
    • Hide

      None

      Show
      None
    • False
    • Important

      Structure inside Logging 6.y

      Checking the Logging 6 documentation, there are some missing sections that we have for Logging 5 but not in Logging 6. For instance:

      • troubleshooting Logging"
      • "Configuring Log Forwarding" all the existing types (ES, HTTP, Syslog, Splunk...),
      • "Logging Alerts"
      • "Scheduling Resources"
      • "Overview"
      • "Installation"

      The best approach could be to follow this Doc Bug for Logging 5 structure --> https://issues.redhat.com/browse/OBSDOCS-924 and apply the same criteria for the logging 6 part because the missing parts are only for RHOL 5 and the examples are not adapted to Logging 6.

       

      Structure in Logging documentation in global:

      The examples are not adapted to Logging 6 requires a longer explanation. If it's browsed the Logging documentation. It's in the first level sections as Installing Logging, Visualizing Logs, Performance and tuning, etc. The most of these sections are for Logging 5.y and not valid for Logging 6, but it's not possible for a reader to know it, this creates frustration as nothing works and/or the creation of the resources return errors or even worst, it does nothing and silently discarded the configuration

       

       

       

       

              landerso@redhat.com Libby Anderson
              acandelp Adrian Candel
              Votes:
              1 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated: