Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-7126 CQA 2.1 : Quality : Authorization
  3. RHDEVDOCS-7118

Quality Assessment: Content is clearly written and understandable

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • 2
    • ---
    • ---

      Criteria: Refer to the 'Minimalism Standards' for clear and understandable writing.

      Task: Assess the overall clarity and understandability of this document.

      Output Format: Clear Sections: The YAML examples in ob-basic-authentication.adoc and ob-ssh-authentication.adoc are clear and well-annotated. Unclear/Complex Sentences: "This annotation filters secrets which are not referenced in a build instance.".

      • Suggestion: "This annotation ensures the controller ignores secrets not referenced by a build." Passive Voice: "The authentication is done through the definition of secrets...".
      • Suggestion: "You authenticate by defining secrets..."

              Unassigned Unassigned
              rhn-support-ssathe Shivani Sathe
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: