• RHDH Documentation 3279, RHDH Documentation 3281

      Ensure that all links in your repository are full path links instead of relative anchor links.

      For more information, see DITA Linking Strategy sessions:

       

      TODO:

       

      1. Concept/Reference modules:
        1. To reduce user confusion, move your inline links to additional resources in asciidoc.
        2. In the additional resources section in asciidoc, do not add text with your link. The related links section of DITA does not allow text.
      2. Procedure modules:
        1. Place links inline in procedure modules where they support the task, such as in prerequisites, relevant steps, or UI references.
        2. Prioritize readability by avoiding mid-sentence links.
      3. Assembly modules:
        1. To clarify. Probably more the additional resources strategy. See https://redhat-internal.slack.com/archives/C04BUB89ETG/p1757494744325499  our DITA topics only include concept, task, and reference. Most of the time we convert these to concept topics, but I have seen the occasional assembly that might be better as a task or reference topic. Depending on how your assembly content is written, I recommend that you treat the links as you would in an equivalent concept, procedure, or reference module.
      4. Ensure links add value.
        1. Evaluate the purpose of each link. Ask yourself: Is this link meant to navigate, reuse content, or provide context? Remove or revise links that are outdated or unnecessary.
        2. Prioritize Critical Information. If the information is critical, consider including it instead of cross-referencing.
      5. Skip Standardize all cross-references. Keep xref:id[Text] statements as it is a requirement for `ccutil`, essential tool in the GitHub repository. Discussed and approved wirth jhradile@redhat.com during a presentation on the topic.

              ffloreth@redhat.com Fabrice Flore-Thébault
              rhn-support-tradej Tomas 'Sheldon' Radej
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: