Skip to content

RHIDP-12611: Document the RHDH must-gather tool for diagnostics data collection#2151

Open
jmagak wants to merge 1 commit into
redhat-developer:mainfrom
jmagak:RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection
Open

RHIDP-12611: Document the RHDH must-gather tool for diagnostics data collection#2151
jmagak wants to merge 1 commit into
redhat-developer:mainfrom
jmagak:RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection

Conversation

@jmagak
Copy link
Copy Markdown
Member

@jmagak jmagak commented May 1, 2026 •
edited
Loading

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented May 1, 2026 •
edited
Loading

PR Build Results

Build passed -- 35/35 titles | 72s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2151/

Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.

Updated 2026-05-21 18:44:22 UTC

@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 6bb563d to aee87bf Compare May 4, 2026 10:37
rm3l
rm3l suggested changes May 5, 2026
View reviewed changes
Comment thread ...les/support_diagnostic-data-collection/con-diagnostic-data-collection-for-support-cases.adoc Outdated
Comment thread ...les/support_diagnostic-data-collection/con-diagnostic-data-collection-for-support-cases.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread ...port_diagnostic-data-collection/ref-platform-compatibility-and-supported-configurations.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...ion/proc-collect-heap-dumps-with-custom-sigusr2-configuration-to-diagnose-memory-issues.adoc Outdated
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from aee87bf to 31d09c4 Compare May 5, 2026 13:28
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 31d09c4 to bd9e729 Compare May 5, 2026 13:32
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from bd9e729 to e8384e6 Compare May 5, 2026 14:26
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from e8384e6 to d5dc1b5 Compare May 5, 2026 15:16
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from c9f7cb6 to 3099922 Compare May 6, 2026 11:10
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 3099922 to 19afd22 Compare May 6, 2026 12:30
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 19afd22 to 8928639 Compare May 7, 2026 09:45
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 2270685 to 935022c Compare May 15, 2026 10:44
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 935022c to 94688b4 Compare May 15, 2026 13:29
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 94688b4 to 7f62556 Compare May 15, 2026 13:43
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 7f62556 to a101cee Compare May 15, 2026 13:47
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 2cd0a1e to 9eb6496 Compare May 18, 2026 13:09
themr0c
themr0c reviewed May 20, 2026
View reviewed changes
Comment thread modules/discover_about-rhdh/ref-rhdh-support.adoc Outdated
Comment thread ...ssembly-generate-diagnostic-data-using-the-must-gather-tool-to-streamline-support-cases.adoc Outdated
themr0c
themr0c reviewed May 20, 2026
View reviewed changes
Comment thread artifacts/attributes.adoc Outdated
rm3l
rm3l reviewed May 21, 2026
View reviewed changes
Comment thread .../observe_diagnostic-data-collection/ref-configuration-options-for-diagnostic-collection.adoc Outdated
Comment thread .../observe_diagnostic-data-collection/ref-configuration-options-for-diagnostic-collection.adoc Outdated
Comment thread .../observe_diagnostic-data-collection/ref-configuration-options-for-diagnostic-collection.adoc Outdated
Comment thread ...ssembly-generate-diagnostic-data-using-the-must-gather-tool-to-streamline-support-cases.adoc Outdated
Comment thread ...erve_diagnostic-data-collection/ref-platform-compatibility-and-supported-configurations.adoc Outdated
Comment thread ...erve_diagnostic-data-collection/ref-platform-compatibility-and-supported-configurations.adoc Outdated
Comment thread ...ssembly-generate-diagnostic-data-using-the-must-gather-tool-to-streamline-support-cases.adoc
rm3l
rm3l reviewed May 21, 2026
View reviewed changes
Comment thread modules/observe_diagnostic-data-collection/ref-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread ...bserve_diagnostic-data-collection/ref-diagnostic-data-output-structure-and-organization.adoc Outdated
Comment thread ...ssembly-generate-diagnostic-data-using-the-must-gather-tool-to-streamline-support-cases.adoc Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 21, 2026

Quality Gate Passed 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@themr0c themr0c themr0c left review comments

+1 more reviewer

@rm3l rm3l rm3l approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

do-no-merge/review-in-progress 👀 Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jmagak @rhdh-bot @themr0c @rm3l