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

Document policy description field

XMLWordPrintable

    • False
    • None
    • False
    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

      Describe the changes in the doc and link to your dev story

       

      This change allows for a new policy description annotation (policy.open-cluster-management.io/description) to be set to describe the purpose of a policy. This description will show up in the UI in the policy overview page (when the list item for the policy is expanded) and in the policy details page.

      Provide info for the following steps:

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

      2.8

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

            - [ ] New topic in an existing section or new section
            - [x ] Update to an existing topic

       

      https://github.com/stolostron/rhacm-docs/blob/2.8_stage/governance/create_policy.adoc#viewing-your-security-policy-from-the-console - description is in details page

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/governance/governance#manage-security-policies - description is viewable in overview dropdown for each policy

       

      3. - [ ] Mandatory for GA content:
                  
             - [ ] Add steps and/or other important conceptual information here: 
      Set the policy.open-cluster-management.io/description annotation. This can be set when creating a policy from the CLI or when creating a policy through the UI - there is a new "description" text box

            
                  
             - [ ] Add Required access level for the user to complete the task here:

      n/a
             

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)

      Description will be viewable from the policy overview page or in the policy details page
           
           
             - [ ] Add link to dev story here: https://issues.redhat.com/browse/ACM-3189?filter=-1

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

              mdockery@redhat.com Mikela Jackson
              wkutler@redhat.com William Kutler
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: