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

Doc Research: QuickStart and Getting Started guides

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Minor Minor
    • None
    • None
    • POC1-prework
    • None
    • 5
    • False
    • Hide

      None

      Show
      None
    • False
    • +
    • Red Hat build of Quarkus

      This task tracks the doc research work to investigate the Red Hat guidelines (CCS-wide, Runtimes etc) and good examples of QuickStart and Getting Started information types.

      The task also aims to answer the following questions in preparation for future doc planning and alignment between upstream and downstream docs:

      1. How does the TW discipline typically define QS and GS guides?
      2. What are the primary goals and key benefits of each information type?
      3. What are the intended differences between each information type?
      4. How are both types used in Quarkus upstream today?
      5. How do they differ between product docs today?
      6. Do we have CCS Guidelines for the use of each in Red Hat?
        a) What are some really good examples of QSs and GS guides in Red Hat?
      7. Do we have a preferred Runtimes approach to QS v GS?
        a) What are some good Runtimes doc examples to follow?
      8. How are both types used in Sprint/Micronaut and other Quarkus competitors?

       

      Miro board to track the doc research:
      https://miro.com/app/board/uXjVOpSWJu0=/?share_link_id=617048373448

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

                Created:
                Updated:
                Resolved: