-
Feature
-
Resolution: Done
-
Normal
-
None
-
False
-
-
False
-
-
0% To Do, 0% In Progress, 100% Done
-
-
Feature Overview (aka. Goal Summary)
- Transfer and integrate the Orchestrator end-user documentation from the current external site (https://www.rhdhorchestrator.io/main/docs/) to the official RHDH documentation.
- Create a consistent documentation experience for RHDH users who want to use the Orchestrator functionality.
- Ensure all critical Orchestrator documentation is available within the official RHDH documentation.
Goals (aka. expected user outcomes)
- Provide a single source of truth for all RHDH and Orchestrator documentation.
- Enable users to find complete Orchestrator documentation within the official RHDH documentation.
- Ensure documentation consistency in style, format, and accessibility.
Requirements (aka. Acceptance Criteria):
- Documentation Analysis:
- Work with Product Management to identify which parts of the current Orchestrator documentation need to be transferred.
- Analyze the current documentation structure at https://www.rhdhorchestrator.io/main/docs/.
- Map existing documentation sections to the RHDH documentation structure.
- Content Transfer:
- Create a new Orchestrator section in the RHDH documentation.
- Transfer and adapt content from the following sections:
- Quick Start
- Architecture
- Core Concepts
- Installation
- Serverless Workflows
- Plugins
- Ensure all diagrams, code examples, and other assets are properly transferred.
Out of Scope (Optional)
- Creating new Orchestrator documentation content beyond what exists in the current site.
- Rewriting existing documentation unless required for integration purposes.
Customer Considerations (Optional)
- Documentation should clearly indicate which Orchestrator features are supported on which platforms (OpenShift vs. AKS/EKS/GKE).