docs(must-gather): update instructions with the wait and timeout options

[rm3l]

Description of the change

Update README.

Which issue(s) does this PR fix or relate to

—

How to test changes / Special notes to the reviewer

Checklist

• For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
• For each Chart updated, variables are documented in the values.yaml and added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Run pre-commit run --all-files to run the hooks and then push any resulting changes. The pre-commit Workflow will enforce this and warn you if needed.
• JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
• Tests pass using the Chart Testing tool and the ct lint command.
• If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

[rhdh-qodo-merge]

Code Review by Qodo

🐞 Bugs (1)   📘 Rule violations (0)   📎 Requirement gaps (0)

🐞\ ≡ Correctness (1)

1. Broken optional flags syntax 🐞 ≡

Description

The TL;DR Helm command includes literal square brackets around optional flags (`[--wait
--timeout=$duration]), so copy/pasting it into a shell will pass [/]` (or trigger glob
expansion) and cause the helm command to fail. This breaks the primary installation instructions
for the chart.

Code

charts/must-gather/README.md.gotmpl[R21-24]

helm upgrade --install my-rhdh-must-gather redhat-developer-hub-must-gather \
  --repo https://redhat-developer.github.io/rhdh-chart \
-  --version {{ template "chart.version" . }}
+  --version {{ template "chart.version" . }} \
+  [--wait --timeout=$duration]

Relevance

⭐⭐⭐ High

Team fixes broken README Helm commands; similar must-gather README example issues were accepted
previously.

PR-#326
PR-#239

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

Both the template and the generated README present the bracketed options inside a copy/paste-able
console code block, which makes the brackets part of the command. The repo’s pre-commit config
shows helm-docs uses README.md.gotmpl as an input template, so this example will propagate into
the generated README users read.

charts/must-gather/README.md.gotmpl[20-25]
charts/must-gather/README.md[27-32]
.pre-commit-config.yaml[2-14]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The README TL;DR command block contains `[--wait --timeout=$duration]` which is not valid to paste into a shell because the brackets become literal arguments (or expand via globbing).

## Issue Context
This appears in both the `README.md.gotmpl` (source template) and the generated `README.md`.

## Fix Focus Areas
- charts/must-gather/README.md.gotmpl[20-35]
- charts/must-gather/README.md[25-42]

## Suggested change
Replace the single command with either:
1) Two explicit commands (one basic, one with `--wait --timeout=...`), or
2) Keep one command and move the optional flags outside the code block (or as a commented line), e.g.:

```console
helm upgrade --install ... \
 --version ...
# Optional: add --wait --timeout=15m
```

Then regenerate `README.md` (via helm-docs/pre-commit) so both files stay consistent.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[rhdh-qodo-merge]

Review Summary by Qodo

Update must-gather chart with wait/timeout options documentation

📝 Documentation ✨ Enhancement

Walkthroughs

Description

• Bump must-gather chart version from 0.4.0 to 0.5.0
• Add --wait and --timeout options to helm installation instructions
• Document default 5-minute Helm timeout limitation and recommendation to adjust
• Update both template and generated README files consistently

Diagram

flowchart LR
  A["Chart Version 0.4.0"] -- "bump version" --> B["Chart Version 0.5.0"]
  C["Installation Instructions"] -- "add wait/timeout options" --> D["Enhanced Instructions"]
  E["README Template"] -- "update documentation" --> F["Generated README"]
  D -- "include timeout guidance" --> G["User Guidance Added"]

Loading

File Changes

1. charts/must-gather/Chart.yaml ⚙️ Configuration changes +1/-1

Bump chart version to 0.5.0

• Bumped chart version from 0.4.0 to 0.5.0 following semantic versioning

charts/must-gather/Chart.yaml

---

2. charts/must-gather/README.md 📝 Documentation +8/-2

Add wait/timeout options and documentation

• Updated version badge from 0.4.0 to 0.5.0
• Added --wait --timeout=$duration options to helm installation command
• Added documentation explaining --wait behavior and default 5-minute timeout limitation
• Included recommendation to adjust timeout based on diagnostic data collection needs

charts/must-gather/README.md

---

3. charts/must-gather/README.md.gotmpl 📝 Documentation +7/-1

Add wait/timeout options to template

• Added --wait --timeout=$duration options to helm installation command template
• Added documentation explaining --wait behavior and default 5-minute timeout limitation
• Included recommendation to adjust timeout based on diagnostic data collection needs
• Ensures consistency with generated README.md file

charts/must-gather/README.md.gotmpl

---