Uploaded image for project: 'Red Hat OpenShift Control Planes'
  1. Red Hat OpenShift Control Planes
  2. CNTRLPLANE-2600

Create a HyperShift cli doc generator

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • HyperShift
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None
    • None
    • None

      Background

      The hcp (used by customers) and hypershift (used by HyperShift developers) CLIs share code but expose different flags. hcp users need clear documentation of available flags, while developers need to understand which flags are developer-only.

      Currently there's no single source of truth documenting these differences, leading to confusion about flag availability and requirements.

      Solution

      Add hypershift docs generate command that auto-generates markdown documentation comparing CLI flags between hcp and hypershift CLIs.

      Key features

      • Extracts flags from both CLIs and shows per-CLI availability
      • Detects required flags via cobra annotations (not hardcoded)
      • Shows three-state status in Required section: ✓ (required), Optional, Unavailable
      • Integrated with make cli-docs target

       Scope

      Starting with AWS create cluster command (extensible to other platforms/commands)

              rh-ee-aabdelre Ahmed Abdalla Abdelrehim
              rh-ee-aabdelre Ahmed Abdalla Abdelrehim
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: