Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-33247

[enterprise-4.15] Issue in file scalability_and_performance/cnf-low-latency-tuning.adoc

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Minor Minor
    • None
    • 4.13.z, 4.12.z, 4.14.z, 4.15.z
    • Documentation / CNF
    • Low
    • None
    • False
    • Hide

      None

      Show
      None

      The Docfooding team reviewed this module and have several suggestions for improvements:

      Feedback on conceptual content

      • I wasn't sure if this module was part of a larger procedure (ToC refactoring currently in progress by Aidan so that should fix this issue)
      • What is QoS and why would you want to do this - context needed.

      Feedback on procedural content

      • Create a namespace as step 1, or else show a variable for the namespace in the existing step 1 codeblock. 
      • Add the following image in the YAML so the user can test the procedure easily without the need to locate a sample image themselves. Or, if keeping a variable for the image in the YAML, have a callout suggesting this sandbox, public image: image: quay.io/openshifttest/hello-openshift:openshift
      • Move the YAML into the procedure as is typical of other procedures
      • The first command has an extra space after "oc" 
      • Optional: could you use a grep command to parse the example output. Also possibly move into a Verification section.  

      See the Docfooding workshop minutes for links to the individual user experience journals of Docfooders, and the link to the workshop recording.

      Version-Release number of selected component (if applicable):

          4.12+

              rhn-support-rohennes Ronan Hennessy
              rhn-support-rohennes Ronan Hennessy
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: