Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-5544

Fix asciidoc internal base path

XMLWordPrintable

    • 5
    • False
    • None
    • False
    • No

      1. - [x] Mandatory Add the required version to the Fix version/s field.

      2. - [x] Mandatory Choose the type of documentation change.

            - [ ] New topic in an existing section or new section
            - [x] Update to an existing topic

      3. - [x] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here: 

      The asciidoc rendering engine derives its internal base path from the path of the rendered main document (in other words, the master.adoc/main.adoc file). A correct internal base bath is required to build functioning cross-folder/cross-book links.
                  
             - [ ] Add Required access level for the user to complete the task here:
             

             - [x] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
           
      An image in the content of a subfoldered component renders correctly in the source AND the build on Pantheon is green.
           
             - [ ] Add link to dev story here:

      4. - [x] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

      Currently, our internal base path for all subfoldered components is incorrect. This is the reason why we had to switch our build to html-single to resolve the MCE link issues. It is also the reason why images do not work correctly, because images are resolved relative to the internal base path of asciidoc. If that base path is incorrect, asciidoctor cannot build images, leading to build failures in Pantheon, as recently seen with business continuity.

      In order to fix this, we need to add the missing main.adoc files to each subfoldered component, modify the existing main.adoc files that are affected by this to reflect this change, and fix the path of links that link to subfoldered components.  

              rh-ee-ofischer Oliver Fischer
              rh-ee-ofischer Oliver Fischer
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: