Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-9995

[Doc][Service Mesh Migration Phase 0] Change links based on linking strategy

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • Documentation

      Make changes to your links based on the linking strategy updates.

      Thing to keep in mind while refining links (by using above references):

      • Make all link content clickable.
      • Check the noun definer for all external links. For example, Kubernetes “documentation”.
      • Check for extra capitalisation in link text.
      • Check and remove ID-based xrefs.
      • Re-check for unnecessary links.
      • Remove or update outdated links.
      • If the information is critical, consider including it instead of cross-referencing.
      • Place links in procedure modules where they support the task, such as in prerequisites, relevant steps, or UI references can remain inline.
      • Be judicious with your linking. If you have a dozen links in your additional resources section, you might need to remove some.
      • Additional resource sections in DITA do not allow extra text. Check.

          There are no Sub-Tasks for this issue.

              rhn-support-ssiddhar Shreya Siddhartha
              kcook@redhat.com Karie Cook
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: