Uploaded image for project: 'Red Hat OpenStack Services on OpenShift'
  1. Red Hat OpenStack Services on OpenShift
  2. OSPRH-17383

Public documentation for RHOSO operators version mappings

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • rhos-18.0.10 FR 3
    • rhos-18.0.10 FR 3
    • documentation
    • None
    • Public documentation for RHOSO operators version mappings
    • False
    • Hide

      None

      Show
      None
    • False
    • RHOSSTRAT-821Public documentation for RHOSO operators version mappings
    • Not Selected
    • Proposed
    • Proposed
    • Done
    • RHOSSTRAT-821 - Public documentation for RHOSO operators version mappings
    • Proposed
    • Proposed
    • 0% To Do, 0% In Progress, 100% Done
    • Moderate

      Goal:

      • This epic is to track the implementation of updating the internal Confluence page to match RH style guide and port the content to a KB article for publication
      • Update internal processes to add a release task at each milestone to update the KB article (operator bundle versions get updated constantly)
      • Stretch goal: Automation or script could speed up the process (might get deferred if there are capacity or technical issues)

      Acceptance Criteria:

      • Internal Confluence page is updated (values will be owned by RelDel and updated before each release)
      • KB article is up to style guide standards and includes the latest version mappings at the time of publication
      • Child bugs are resolved and fix approved

      Mini Content Journey

      Reviewers:

      • Technical: [name]
      • Peer: [Writer name]
      • QE: [name]
      • Partner/Field (optional): [name]

      Is this feature fully supported or technical preview?

      • TP exception (Knowledge Base Article / Doc): 
      • If there is a strong customer demand for testing this feature and the writer has capacity, dev/PM can author a KB article or gdoc and if the writer has capacity they can review/edit the article. 
      • If the feature is deemed high-impact by the BU/PM and docs must be published, then include the technicalpreview.adoc module in the doc.

       

      Does the documentation epic need a release note in addition to the feature?

      • No: The engineering feature or epic might still need a release note. Engineers need to follow the guidance set in[ __ How-to Jira with the docs team|https://spaces.redhat.com/display/RHOSPDOC/How-to-Jira+with+the+RHOS+docs+team].

      What stage of the user journey are you targeting?

      • Discover: Overview, reference, blogs (Find solutions)
      • Learn: Validated architectures, reference, FAQ(Gain Knowledge)

      Who is your target persona?

      • RHOSO admin:  Platform Engineer
      • OpenStack admin:  Cloud Administrator
      • OpenStack user: SysAdmin or Developer

      What type of information does the user need to know in order to use the feature?

      • Considerations for upgrades, adoption, or minor updates
      • Planning decisions that must be made

      Are there any existing upstream or internal resources that the writer can use for planning and drafting the content? Consider the situational context of the existing content. Do a Google search for any possible resources that might help.

      Does the content require input from multiple DFGs?

      • Yes: Writer creates spikes or stories under this epic and assigns them to the relevant writers for scoping
      • No: Stories are not required unless the epic needs to be divided to user stories that can be delivered separately (for personal use, consider sub-tasks instead)

      Does the content need to be included in any of the following guides?

      Add links from docs to KBA as described in https://issues.redhat.com/browse/RHOSSTRAT-821 

      • Release notes
      • Planning guide
      • Deployment guide
      • Adoption/minor updates guide

       

              rhn-support-jelynch Jenny-Anne Lynch
              mariel@redhat.com Mikey Ariel
              rhos-product-reldel
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: