Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-4715

Reduce the size of the generated Techdocs content

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • Icon: Feature Feature
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • 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.

            rh-ee-mhild Marcel Hild
            jfargett@redhat.com Christophe Fargette
            RHIDP - Plugins
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: