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

Polish policy Go template docs

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • None

      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 to update to an existing topic

      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. - [ ] 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?)
      • [ ] Add link to dev story here:

      5. - [x] 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.

      Not a bug per se, but I noticed some things about the templating doc that I thought could use a polish:

      • The YAML in the template functions section contains a lot of parameters that could be removed in order to bring focus to the relevant portions
      • The advanced templating document title contains "configuration policy", which isn't entirely accurate since some sections apply to Policy
      • The hub/managed cluster templating comparison table has a separate "policy metadata" row that can be consolidated with the context variable row.

      Reference PR: https://github.com/stolostron/rhacm-docs/pull/7525

              jberger@redhat.com Jacob Berger
              rh-ee-dhaiduce Dale Haiducek
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: