Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-8883

Image Updater: Docs: ReadTheDocs YAML Rendering Bug

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • ImageUpdater
    • None
    • GitOps Tangerine Sprint 28


      Description of Problem

      YAML code blocks in the documentation are rendered as a continuous line of unformatted text on ReadTheDocs, while they display correctly on GitHub. This occurs because leading whitespaces before the code fence (```yaml) break the parser's ability to recognize the block. The fix is to remove the spaces preceding the code fences in the source Markdown.

      Additional Info

      • Source File: docs/install/installation.md

      Problem Reproduction

      Navigate to the ReadTheDocs link and locate the section "Grant Permissions in the Argo CD Namespace."

      Steps to Reproduce

      1. Open the project documentation on ReadTheDocs.
      1. Navigate to the "Installation" section.
      1. Observe the YAML manifest under "Option 2".

      Expected Results

      The manifest should be contained within a formatted code block with proper indentation and syntax highlighting.

      Actual Results

      The YAML appears as a single, broken string of text: Create and apply the following manifest in the <argocd_namespace>: ```yaml apiVersion: rbac.authorization.k8s.io/v1...

        •  

              dkarpele@redhat.com Denis Karpelevich
              dkarpele@redhat.com Denis Karpelevich
              Tangerine
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: