XMLWordPrintable

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

      Criteria: Sentence Length (22 words), Paragraph Length (2-3 sentences), Bulleted Lists, Graphics.

      Task: Review the document for scannability based on the criteria above.

      Output Format: Sentences exceeding 22 words:

      1. "Reconciling on triggering of events allows the build controller to re-trigger validations on the build configuration, helping you to understand if a dependency is missing." (23 words).
      2. "Based on this annotation, the build controller takes a reconcile action when an event, such as create, update, or delete triggers for the build secret." (24 words).
      3. "You can change this setting by creating a separate Kubernetes ClusterRole role with these permissions and binding the role to appropriate users." (22 words - borderline).

      Paragraphs containing more than three sentences: None found. Paragraphs are generally short.

      Comment on the appropriate use and presence of bulleted lists: Bulleted lists are used appropriately in the assembly introduction and in ob-authentication-to-git-repositories.adoc to list authentication types.

      Regarding Graphics/Diagrams: The document explains authentication flows involving Secrets, Build CRs, and the Build Controller. A workflow diagram illustrating the relationship between the Build CR, the Secret (with annotations), and the execution logic would demonstrably benefit user understanding of how these components link together at runtime.

      Summary: Overall scannability is good, but specific long sentences regarding controller logic should be shortened.

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

                Created:
                Updated:
                Resolved: