Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-128

Work with upstream community to improve navigation features in Quarkus community docs UI

XMLWordPrintable

    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Quarkus Upstream Docs Sprint 3, Quarkus Upstream Docs Sprint 4, Quarkus Upstream Docs Sprint 5, Quarkus Upstream Docs Sprint 6, Quarkus Upstream Docs Sprint 7, Quarkus Upstream Docs Sprint 8, Quarkus Docs Sprint 25

      Multiple stakeholders in the Quarkus community have given feedback that the navigation and findability experience in the Quarkus upstream docs portal site has some gaps and needs to be enhanced.

      The new diataxis-styled landing page is greatly improved and provided good navigation and filtering options by content type and by technical topic.

      However...

      Problems:

      • When you open a page, you lose a sense of where you are and what other related information is available in this category.
      • There are too many single pages at the top level, which means a lot of content on the main index/splash pages with very basic filtering.
      • The current architecture of the portal relies on individual links to the other topics in the docs portal. This is a manual effort that needs maintenance.
      • The Quarkus user has to find those links or use the back button to get back to the top-level landing page. This is poor IA.

      Scope of this JIRA:

      To work with the upstream key stakeholders to implement a taxonomy and navigation structure (TOC, breadcrumb trail, and/or other ) that is dynamic and complements the main doc index page. The IA could also be leveraged by the downstream doc single-sourcing effort.

       

       

       

       

        1. image-2023-02-08-12-38-25-970.png
          56 kB
          Michelle Purcell
        2. image-2023-05-09-07-57-28-970.png
          27 kB
          Michelle Purcell

              Unassigned Unassigned
              sbiarozk Sergey Beryozkin
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Created:
                Updated: