Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-12207

CQA 2.1 compliance: Authentication in Red Hat Developer Hub

    • RHDH Documentation 3287

      CQA 2.1 compliance: Authentication in Red Hat Developer Hub

      Task

      Fix the  Authentication in Red Hat Developer Hub title content to be compliant with CQA 2.1 – Content Quality Assessment.

      Background

      CCS is migrating documentation to Adobe Experience Manager. All the content must be compatible with DITA and AEM before migrating. The CQA 2.1 – Content Quality Assessment defines requirements to meet: https://docs.google.com/spreadsheets/d/1wF_NUWXBJaYsaXp8Dn6TQOx9gD45NCqNxaPkXhYN-zI/edit?gid=503904153#gid=503904153 

      Dependencies and Blockers

      Acceptance Criteria

      Asciidoc

      • Content passes this Vale asciidoctor-dita-vale tool check with no errors or warnings.
        The AsciiDocDITA tool identifies markup that does not have a direct equivalent in DITA 1.3. See the readme for details about specific issues that it finds. Note: The AsciiDocDITA tool is updated frequently.
      • Assemblies should contain only an introductory section, which can be one or more paragraphs, and include statements. You can also have an Additional resources section at the end of the assembly, after all of the includes.
        DITA maps do not accept text between include statements for modules.

      Modularization

      • Concept
      • Procedure
      • Reference
      • Assemblies use the official template.
        Assemblies are one user story.
      • Content is not deeply nested in the TOC (recommended: no more than 3 levels).
        Note: For migration, you can start counting levels where your content starts, not including categories and the repetitive book titles that Pantheon generates.

      Titles and short descriptions

      • Modules and assemblies start with a clear short description. A short description:
      • In asciidoc, short descriptions must be:
      • be a single paragraph between 50 and 300 characters
      • Introduced with [role="_abstract"]
      • Include a blank line between the level 0 (=) title and the short description in asciidoc
        Note: See Rewrite for Impact: DITA short descriptions
      • Titles are brief, complete, and descriptive.
        Use the following guidelines for titles:
        - Procedure modules
        in the Modular documentation reference guide

      Procedures

      • Use the Prerequisites label
      • Use consistent formatting
        Do not exceed 10 prerequisites.
        Do not include steps in prerequisites.

      Editorial

      • Content is grammatically correct and follows rules of American English grammar
      • Information is conveyed using the correct content type

      URLs and links

      • No broken links
      • Redirects (if needed) are in place and work correctly

      Legal and Branding

       

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: