Skip to content

[RHDEVDOCS-7365]: Add gathering diagnostic information procedure for OpenShift Pipelines#113892

Open
kamalinimukherjee wants to merge 1 commit into
openshift:pipelines-docs-mainfrom
kamalinimukherjee:RHDEVDOCS-7365-final-fix
Open

[RHDEVDOCS-7365]: Add gathering diagnostic information procedure for OpenShift Pipelines#113892
kamalinimukherjee wants to merge 1 commit into
openshift:pipelines-docs-mainfrom
kamalinimukherjee:RHDEVDOCS-7365-final-fix

Conversation

@kamalinimukherjee

@kamalinimukherjee kamalinimukherjee commented Jun 23, 2026

Copy link
Copy Markdown

**

This pull request adds the new procedure module for gathering diagnostic information for OpenShift Pipelines, fully formatted according to the OpenShift contributor guidelines.

Version(s):
Latest (main)

Issue:
https://issues.redhat.com/browse/RHDEVDOCS-7365

Link to docs preview:
*Pending automated ocpdocs-previewbot build comment*

QE review:
- [x] QE has approved this change.

Additional information:
- Verified that the PR contains exactly one squashed commit.
- Document structure uses correct modular tags (`:_mod-docs-content-type: PROCEDURE`).
- Validated all step continuity blocks (`+` symbols), itemization formatting, and added additional resources per peer review feedback.

@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 23, 2026
@openshift-ci

openshift-ci Bot commented Jun 23, 2026

Copy link
Copy Markdown

Hi @kamalinimukherjee. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kamalinimukherjee

kamalinimukherjee commented Jun 23, 2026

Copy link
Copy Markdown
Author

@Dhruv-Soni11 updated the branch to pipelines-docs-main.
@ochromy Updated most of your feedback

Dhruv-Soni11
Dhruv-Soni11 reviewed Jun 23, 2026
View reviewed changes
Comment thread modules/op-proc-gathering-diagnostic-information.adoc
For prompt support, provide diagnostic information for both OpenShift Container Platform and {pipelines-title}.
====

== About the must-gather tool

@Dhruv-Soni11 Dhruv-Soni11 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This topic should be added in a separate concept.

Dhruv-Soni11
Dhruv-Soni11 reviewed Jun 23, 2026
View reviewed changes
Comment thread modules/op-proc-gathering-diagnostic-information.adoc

Optionally, you can run the `oc adm must-gather` command in a specific namespace by using the `--run-namespace` option.

.Example command for a specific namespace

@Dhruv-Soni11 Dhruv-Soni11 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the guidelines for using a format like this. Ask Shivani for more info regarding this.

Dhruv-Soni11
Dhruv-Soni11 reviewed Jun 23, 2026
View reviewed changes
Comment thread modules/op-proc-gathering-diagnostic-information.adoc
$ oc adm must-gather --image=quay.io/openshift-pipeline/must-gather --run-namespace=<namespace>
----

== Collecting debugging data for {pipelines-title}

@Dhruv-Soni11 Dhruv-Soni11 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This topic should be ideally added in a separate procedure.

Dhruv-Soni11
Dhruv-Soni11 reviewed Jun 23, 2026
View reviewed changes
Comment thread modules/op-proc-gathering-diagnostic-information.adoc
@@ -0,0 +1,105 @@
// This module is included in the following assemblies:

@Dhruv-Soni11 Dhruv-Soni11 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content must be differentiated into an assembly, a procedure, and a concept. Cramming everything into a single file is not the correct way as per our guidelines. I assume that it is the reason why the PR is not building a preview since the last couple of hours.

@Dhruv-Soni11 Dhruv-Soni11 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can follow this for more guidance: https://github.com/Dhruv-Soni11/openshift-docs/blob/gitops-docs-main/understanding_openshift_gitops/gathering-gitops-diagnostic-information-for-support.adoc

@Dhruv-Soni11

Dhruv-Soni11 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Reviewing the content is immaterial until you fix the structural issues, @kamalinimukherjee. Kindly let me know if I can assist you further.

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

Reviewers

@Dhruv-Soni11 Dhruv-Soni11 Dhruv-Soni11 left review comments

Assignees

No one assigned

Labels

needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kamalinimukherjee @Dhruv-Soni11