-
Feature
-
Resolution: Unresolved
-
Major
-
None
-
M
-
False
-
-
False
-
50% To Do, 50% In Progress, 0% Done
-
-
Feature Overview (aka. Goal Summary)
Develop a prototype TechDocs pipeline using GitHub Actions to enhance documentation capabilities without modifying the existing RHDH image.
This feature is a replacement for
Implementing the TechDocs pipeline in an external CI, such as GitHub Actions, rather than within the RHDH image is recommended by upstream and our own documentation and offers several advantages:
1. Separation of Concerns: By keeping the TechDocs pipeline separate from the Backstage instance, we maintain a clear separation
between the documentation generation process and the display of documentation.
2. Maintainability: Extensions to the techdocs pipeline can be done by the customer.
3. Scalability and Performance: documentation generation can handle larger workloads and persist between restarts of RHDH (not on ephemeral storage).
Goals (aka. expected user outcomes)
- Users can generate TechDocs using a GitHub Actions pipeline.
- The pipeline supports video content and minification.
- The solution is based on the upstream TechDocs container.
- Future conversion to Tekton is planned for better OCP integration.
Requirements (aka. Acceptance Criteria):
- A working GitHub Actions pipeline for TechDocs.
- Support for video content and minification in the pipeline.
- No modifications to the existing RHDH image.
- Documentation for user implementation
- Pipeline creates the TechDocs in an S3 bucket.
- The techdocs are consumed by our internal RHDH instance
- Requirements in those features are included in this pipeline:
Out of Scope (Optional)
- Direct modifications to the RHDH image.
- Immediate implementation of Tekton.
Customer Considerations (Optional)
- Users should be able to implement the pipeline independently.
- The pipeline should be adaptable to different environments.
Documentation Considerations
- Provide documentation on setting up and using the GitHub Actions pipeline
Resources
- incorporates
-
-
- Closed
-
-
-
- Closed
-
