Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-2958

[H] Helm Documentation Revamp

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Critical
    • SBO 1.0 GA
    • None
    • Helm
    • 5
    • Undefined

    Description

      Problem:

      Documentation on Helm support for OpenShift is everywhere and not efficient enough at connecting all the different pieces together. It's likely that a end-user will miss information and not understand the complete scope of the Helm support on openshift.

       

      For example, 3 different places where it is speaking about Helm:

      Goal:

      Helm continues to experience broad adoption in the Kubernetes ecosystem as the defacto package manager. As a result, we need to get Helm a better touch point interaction for our openshift users/customers. Helm must be treated as a first class citizen of OpenShift. 

      That impacts documentation.

      For that, the goal would be to provide a single page about Helm that will highlight all the capabilities that are supported for Helm on OpenShift. We need a single place that will include documentation about:

      • Using Helm Charts provided out of the box
        • Red Hat Charts
        • Community Charts
        • Certified Charts (in this section, we will highlight and reference to the partner certification program)
      • Explain how to configure custom helm Chart
      • Highlight the capabilities provided by the Developer Perspective
      • Highlight, how people can use Helm CLI, how they can get it...
      • Speak about integration with the WebTerminal
      • Speak about the oc-helm plugin
      • Speak about the chart-verifier tool that could be helpful from end-user point of view

      Why is it important?

      Helm continues to experience broad adoption in the Kubernetes ecosystem as the defacto package manager. As a result, we need to get Helm a better touch point interaction for our openshift users/customers. Helm must be treated as a first class citizen of OpenShift. 

      Use cases:

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              slemeur@redhat.com Stevan Le Meur
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: