Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-12200

Embed versioned Gatekeeper Operator docs (strategy)

XMLWordPrintable

    • No

      1. - [x] Mandatory: Add the required version to the Fix version/s field.

      2. - [x] Mandatory: Choose the type of documentation change or review.

      • [x] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section

      3. - [x] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      4. - [x] Mandatory for GA content:

      • [ ] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)
      • [x] Add link to dev story here: ACM-10570

       

      The top two commits in this branch have a proposed draft of the content: https://github.com/dhaiducek/rhacm-docs/commits/10570-gatekeeper/

      • The files use version attributes at the top of each file and conditional rendering to show content relevant to a particular version.

      Copying over from the original dev issue, our goals are (also see notes from the doc guild meeting on June 12):

      • Document the Gatekeeper operator itself (independent of integrations with RHACM)
      • Document the support lifecycle of N-1 (latest and previous) as fully supported and N-2 is CVE fix only support
      • Document the operator channel strategy (e.g. stable vs 3.x channels)
      • Document recommended settings for auditing (e.g. caching with automatic configuration)
      • Document basic installation/configuration
      • Document how to use `oc` to view the API documentation

              mdockery@redhat.com Mikela Jackson
              dhaiduce Dale Haiducek
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: