Uploaded image for project: 'Red Hat OpenStack Services on OpenShift'
  1. Red Hat OpenStack Services on OpenShift
  2. OSPRH-18557

Create documentation for GitOps driven pipelines

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • GitOps
    • None
    • Create documentation for GitOps driven pipelines
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • Proposed
    • Proposed
    • Done
    • Proposed
    • rhos-ops-day1day2-upgrades
    • Proposed
    • 0% To Do, 0% In Progress, 100% Done

      Goal:

      Using gitlab-pages, create a documentation ensuring others are able to understand, create and maintain kustomize overlays, ArgoCD Applications and gitlab pipelines for the continuous deployment and soaking tests.

      Acceptance Criteria:

      • Existing repository is used as a source for a gitlab-pages documentation.
      • Documentation has been reviewed by the team.
      • Documentation has been reviewed by other people consuming our content (NFV, for instance)
      • Documentation has been reviewed or, at least, guided by Doc Team.

      Open questions:

      • Documentation format: is markdown the way to go, if we eventually decide to publish content for customers?
      • Documentation build: does gitlab proposes any native way to build documentation for its "pages" service?
      • Documentation visual template: does Red Hat provide anything for gitlab-pages to have a "corporate visual"?
      • Documentation hosted in other repositories (such as rhos-gitops/examples, rhos-gitops/automation): do we migrate everything into that single "documentation" repository, with appropriate links to relevant sections?

              cjeanner@redhat.com Cedric Jeanneret
              cjeanner@redhat.com Cedric Jeanneret
              rhos-dfg-upgrades
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: