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

Gatekeeper Operator new docs to GRC section

XMLWordPrintable

    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

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

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

      • [ ] We need to update to an existing topic
      • [ ] We need to add a new document to an existing section
      • [x] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note
        for MCE and/or ACM

      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:

      • [x] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • Create a new folder for Gatekeeper (the proposed path is: /governance/gatekeeper_operator/<filename>)
      • Please move the current file, gatekeeper_operator_intro.adoc into the new gatekeeper_operator folder. Also rename it from Gatekeeper operator to Gatekeeper operator overview. (Reminder: Update the goverance/main.adoc file similar to the business_continuity/main.adoc file.)
      • Please list the new files that be added to the governance/main.adoc in the following order:

         - Gatekeeper release notes (gatekeeper_operator/release_notes.adoc) Notes: The release notes should include the Operator versioning topic (most likely renamed to Operator versions) and list what's new for GK 3.11, GK 3.14, and GK 3.15 (discuss with CS and Matt about what's new before review)
         - Gatekeeper requirements (gatekeeper_operator/requirement.adoc) Notes:  add the General support statement to this file. 
         - Gatekeeper channels (gatekeeper_operator/channels.adoc)
         - Integrating constraints and constraint templates (gatekeeper_operator/gatekeeper_policy_constraints.adoc) Reminder: This file already exists, just move to the new folder)
         - Managing policies (gatekeeper_operator/manage_gatekeeper.adoc) Note: The content for this file is in the existing file create_gatekeeper , so we are basically moving and renaming the file. 

      • [ ] *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?)

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

              jberger@redhat.com Jacob Berger
              mdockery@redhat.com Mikela Jackson
              Derek Ho Derek Ho
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: