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

Provide minimal MCE doc for support to bridge gap while MCE 2.5 docs are not available

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

      Provide info for the following steps:

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

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

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

      3. - [ ] Mandatory for GA content:
                  
             - [ ] Add steps and/or other important conceptual information here: 
             

           Thinking this might be a KCS article. Robyn is checking with Scott Suehle. 

      Update from Brandi 3/1
      Slack discussion here: https://redhat-internal.slack.com/archives/GVDCLR7A5/p1708533743837449?thread_ts=1708531151.700479&cid=GVDCLR7A5

       

         Because MCE is releasing 2 weeks before ACM, there will be a lag in the timing between when MCE is available and when its docs are available. Scott asked for anything that we can do to help the support team to provide some information during that time. The suggestion was a KCS article. The thinking is that the following would be helpful if it was available (in a KCS article?) on MCE's GA:

      1. Copy of the What's new information (and maybe known issues) for MCE.
      2. Links to the staging environment and to the source documentation.  
      3. Maybe links to the skills transfer sessions that apply to MCE, in case they missed the sessions. 

      If there is anything else that is easy and helpful to provide, feel free to add it to the list. This should not be much extra work.

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

             - [ ] 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:

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

            bswope@redhat.com Brandi Swope
            chrisadawson Christopher Dawson
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: