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

Intro topics bury important links for the user, part of conversion prep [Duplicate]

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • Documentation
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • None

      We have some long intro topics and we are getting feedback from teams that their customers cannot easily reach their links, which are buried in verbose topics.

      1. Reduce intro paragraphs. Many times we can identify where sentences can be reduced, words can be deleted for shorter paragraphs.
      2. Consider if after the content is written concisely, it can be moved to either an "about x" file or an existing architecture file.
      3. Our users like the introduction files that need to be there bc they don't use navigation. I am hoping we do not lose that high quality UX in the conversion and that we have a voice in that set up. I have made chrisadawson aware of the positive feedback in how we set up these intro topics, both internally and externally.
      4. We would be doing this based on our own initiative and customer feedback, like we always do–and fixing our own contributions, but due to content x requirement, I will label this and all issues.

              Unassigned Unassigned
              bswope@redhat.com Brandi Swope
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: