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

Improve linking between security documents

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • None
    • Upstream-Downstream
    • None
    • Quarkus Upstream Docs Sprint 3

      Right now security documents are not easy to navigate and it is difficult to see in some of them what role a given concept is playing in Quarkus Sec.

      I appreciate a major refactoring is ongoing but I'm a bit concerned the navigation has become more difficult.

      For example,  I started from https://quarkus.io/version/main/guides/security-basic-authentication-concept, clicked on https://quarkus.io/version/main/guides/security-authentication-mechanisms-concept, and could not follow to Identity Providers, so in order to move to the follow up doc related to identity providers I had to click on the Back browser button, then click on the main sec concept link which is available in Basic Auth concept and only from there I found a link to Identity providers.

      The more links we have between the related docs the easier it will be for users to navigate .

      Lets take the authentication mechanism concept as an example. IMHO it should have links to Identity providers and the main sec concept.

      IMHO every other non-main sec concept/tutorial should make it easy for the users get back to the main sec concept but also not require users to click the browser Back, more than once sometimes,  in order to find the related concepts. Starting with adding links to the main sec concept where it is not available yet would be great.

       

              mpurcell@redhat.com Michelle Purcell
              sbiarozk Sergey Beryozkin
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: