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

Harmonize the upstream diataxis headers

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Won't Do
    • Icon: Major Major
    • Quarkus-3.8.GA
    • None
    • Upstream-docs
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      • Nature: What is the nature of the problem?
        • The diataxis headers in some of the community docs are missing elements or are inconsistent with the community's guidelines for contributors
        • Missing items can various problems in the presentation and categorization of the guides, and tend to cause additional work during review cycles. 
      • Intention: What is the intention of this task?
        • Review and fix all diataxis headers to be complete and consistent.
      • Time: How much time is needed to address the problem or how much time is available?
        • This seems to be a non-urgent matter. It would be best to schedule this work for post-3.2 GA. 
      • Special instructions: Is there anything else the writer needs to know about the situation?
        • Some guides do not conform to a particular `diataxis-type`. If this is the case, maybe leave this blank, or "force" the type that best matches the actual content. Before completing this story, let's meet to discuss this case and choose a specific way to handle it.

              rdlugyhe Rolfe Dlugy-Hegwer
              rdlugyhe Rolfe Dlugy-Hegwer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: