Epic Goal

We want to have a single "source of truth" Git repository that generates both upstream Open Cluster Management (OCM) and Red Hat Advanced Cluster Management (ACM) documentation.

Why is this important?

The OCM documentation is currently written by engineers in the OCM community. It has some great content but it's not as complete as the ACM documentation and it's not always kept up to date with new features. It's also duplicating work that often isn't necessary. Additionally, having content written by professional writers will make the content more consumable and allow translations written for ACM to be available in OCM.

This will hopefully improve OCM adoption as it makes the project more accessible and it will highlight new features.

Scenarios

...

Acceptance Criteria

• The https://github.com/stolostron/rhacm-docs GitHub repository content becomes the single "source of truth" for OCM and ACM documentation.
• There is a way to denote content as OCM only or ACM only in the documentation.
• The documentation from the latest in-progress ACM release is automatically rebuilt for OCM for every new commit.
• All ACM documentation that described how to do something through the console must also have an alternative way to do this through the API. OCM would not include console related documentation.
• OCM versioned documentation is not a requirement as of now and would be handled in follow-up work.

Dependencies (internal and external)

1. ...

Previous Work (Optional):

1. ...

Open questions:

1. …

Done Checklist

• CI - CI is running, tests are automated and merged.
• Release Enablement <link to Feature Enablement Presentation>
• DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
  Issue>
• DEV - Upstream documentation merged: <link to meaningful PR or GitHub
  Issue>
• DEV - Downstream build attached to advisory: <link to errata>
• QE - Test plans in Polarion: <link or reference to Polarion>
• QE - Automated tests merged: <link or reference to automated tests>
• DOC - Downstream documentation merged: <link to meaningful PR>