-
Feature
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
False
-
-
False
-
-
Feature Overview (aka. Goal Summary)
Techdocs will generate HTML pages (including CSS, images) from the Markdown content hosted on Git. This generated content can take several hundreds of KB or MB. This is not only affecting the storage space but also the performance in loading the content of documentation.
Goals (aka. expected user outcomes)
The documentation content generated should be optimized/minified. For example, with https://github.com/byrnereese/mkdocs-minify-plugin or any other similar approach. Or in the Techdocs pipeline.
The improvement will be transparent to the users and doc writer.
Requirements (aka. Acceptance Criteria):
The generated Techdocs content should be optimized/minified to improve performance.
Documentation Considerations
The documentation about Techdocs should mention the improvement in the architecture on how Techdocs works in RHDH.
- is related to
-
RHIDP-4714 Documentation writer should be able to add video content in their Techdocs.
- Refinement