Bug 1962374

Summary: logging README.html is rendered incorrectly
Product: Red Hat Enterprise Linux 8 Reporter: Rich Megginson <rmeggins>
Component: rhel-system-rolesAssignee: Rich Megginson <rmeggins>
Status: CLOSED ERRATA QA Contact: David Jež <djez>
Severity: unspecified Docs Contact: Jan Fiala <jafiala>
Priority: unspecified    
Version: 8.5CC: djez, jafiala, nhosoi, spetrosi
Target Milestone: betaKeywords: Triaged
Target Release: 8.5   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: role:logging
Fixed In Version: rhel-system-roles-1.4.0-1.el8 Doc Type: No Doc Update
Doc Text:
Story Points: ---
Clone Of:
: 1978758 (view as bug list) Environment:
Last Closed: 2021-11-09 17:45:29 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1978758    
Attachments:
Description Flags
picture of html rendering none

Description Rich Megginson 2021-05-19 20:46:06 UTC
Created attachment 1784962 [details]
picture of html rendering

Description of problem:
Not sure if this is a kramdoc problem or only asciidoc/pandoc.

This section in the README:

### Standalone configuration

1. Deploying `basics input` reading logs from systemd journal and implicit `files output` to write to the local files.
```yaml
---
- name: Deploying basics input and implicit files output
  hosts: all
  roles:
    - linux-system-roles.logging
  vars:
    logging_inputs:
      - name: system_input
        type: basics
```

is rendered incorrect as seen in the picture.

I think the problem is that the line beginning with 1. is not followed by a blank line, causing the ```yaml to be indented, and lose it's meaning as a block of unformatted text.  I think to fix this, we should remove the 1. numbering in the documentation (here and elsewhere) - we don't need a list here, numbered or ordered or unordered.

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


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 12 errata-xmlrpc 2021-11-09 17:45:29 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (rhel-system-roles bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2021:4159