Expand debugging tips

What does this MR do?

For the related issue, this expands the debugging tips for CI/CD pipelines, to help users identify and fix problems with their own pipelines, hopefully reducing the amount of support tickets for issues that are problems with the user's configuration, not GitLab itself.

Related issues

• Resolves #431992 (closed)
• Related to #431129
• Related to https://gitlab.com/gitlab-org/technical-writing/-/issues/981

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• If you're adding a new page, add the product tier badge under the H1 topic title.
• If you are a GitLab team member, request a review based on:
  • The documentation page's metadata.
  • The associated Technical Writer.

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

• ~"frontend"
• ~"backend"
• ~"type::bug"
• ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

• If the content requires it, ensure the information is reviewed by a subject matter expert.
• Technical writer review items:
  • Ensure docs metadata is present and up-to-date.
  • Ensure the appropriate labels are added to this MR.
  • Ensure a release milestone is set.
  • If relevant to this MR, ensure content topic type principles are in use, including:
    • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
    • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
    • Any task steps should be written as a numbered list.
    • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
• Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

changed milestone to %16.11

added Technical Writing devopsverify docsimprovement documentation grouppipeline authoring maintenancerefactor typemaintenance labels

requested review from @lyspin

assigned to @marcel.amirault

added Category:Pipeline Composition sectionci labels

@lyspin This is just a draft for now, but could you take a first look while I get someone else to verify the suggestions make sense?

@nao.hashizume As someone who regularly has to troubleshoot pipelines, could you verify the additional debugging suggestions make sense? 🙏

requested review from @nao.hashizume

	1 Message
📖	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/ci/debugging.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the 🔁 danger-review job that generated this comment.

Generated by 🚫 Danger

added docs-only label

approved this merge request

removed review request for @nao.hashizume

added 1 commit

• 766a7f01 - Clarify debugging details

Compare with previous version

marked this merge request as ready

added 1 commit

• af573145 - Fixes a typo

Compare with previous version

approved this merge request