Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-8027

Document Support Argo CD Notifications in Any Namespace

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • Operator
    • None
    • GitOps Crimson Sprint 24

      Story (Required)

      • As an Operator User or Administrator, I want to find clear documentation for the support Argo CD Notifications in Any Namespace feature, so that I can understand how to configure it correctly and what its limitations are.

      Background and Approach (Required)

      This feature, as it introduces a UX pattern (duplicating namespace lists) that could confuse users if not explained properly. Because the configuration requires a specific step that might not be immediately obvious, we need to provide clear guidance to ensure users have a successful setup.

      The new documentation will cover:

      • What the Feature Does: A simple explanation of the new notification configuration model and its benefits.
      • Describe the new spec.notifications.sourceNamespaces field.
      • Provide a complete, working YAML example.
      • Include a clear and visible note or warning block that explains that users must add namespaces to both spec.sourceNamespaces (for applications) and spec.notifications.sourceNamespaces for the entire workflow to function in a given namespace.

      Out of Scope

      • <Defines what is not included in this story.>

      Dependencies

      • <Describes what this story depends on. Dependent stories and EPICs should be linked to the story.>

      Acceptance Criteria (Mandatory)

      • <Describe edge cases to consider when implementing the story and defining tests.>
      • <Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story.>

      Definition of Done

      • Code Complete:
        • All code has been written, reviewed, and approved.
      • Tested:
        • Unit tests have been written and passed.
        • Ensure code coverage is not reduced with the changes.
        • Integration tests have been automated.
        • System tests have been conducted, and all critical bugs have been fixed.
        • Tested and merged on OpenShift either upstream or downstream on a local build.
      • Documentation:
        • User documentation or release notes have been written (if applicable).
      • Build:
        • Code has been successfully built and integrated into the main repository / project.
        • Midstream changes (if applicable) are done, reviewed, approved and merged.
      • Review:
        • Code has been peer-reviewed and meets coding standards.
        • All acceptance criteria defined in the user story have been met.
        • Tested by reviewer on OpenShift.
      • Deployment:
        • The feature has been deployed on OpenShift cluster for testing.

              nmirasch@redhat.com Neus Miras Chueca
              nmirasch@redhat.com Neus Miras Chueca
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: