Note: This is a beta release of Red Hat Bugzilla 5.0. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Also email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback here.
Bug 1686743 - Wrong formatting in documentation examples
Summary: Wrong formatting in documentation examples
Keywords:
Status: NEW
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.11.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Xiaoli Tian
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-03-08 08:50 UTC by Jose Ignacio Jerez
Modified: 2019-04-01 07:02 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:


Attachments (Terms of Use)

Description Jose Ignacio Jerez 2019-03-08 08:50:44 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/configuring_clusters/prometheus-cluster-monitoring

Section Number and Name: 

5.3  Configuring etcd monitoring
  Step 3-i and 3-ii

Describe the issue: 

There are two example boxes and the formatting is wrong, the long lines are actually a group of lines, see the correction bellow:

i:
...
data:
  config.yaml: |+
    ...
    etcd: targets: selector: openshift.io/component: etcd openshift.io/control-plane: "true"


ii:
...
data:
  config.yaml: |+
    ...
    etcd: targets: ips: - "127.0.0.1" - "127.0.0.2" - "127.0.0.3"


Suggestions for improvement: 

In this other document the lines are properly formatted:

https://docs.openshift.com/container-platform/3.11/install_config/prometheus_cluster_monitoring.html#configuring-etcd-monitoring


...
data:
  config.yaml: |+
    ...
    etcd:
      targets:
        selector:
          openshift.io/component: etcd
          openshift.io/control-plane: "true"

And

...
data:
  config.yaml: |+
    ...
    etcd:
      targets:
       ips:
       - "127.0.0.1"
       - "127.0.0.2"
       - "127.0.0.3"

Additional information: 

This issue already affected a client and is likely to trick others.


Note You need to log in before you can comment on or make changes to this bug.