Troubleshoot repository mirroring pipelines

What does this MR do?

If CI/CD for external repositories stops triggering pipelines, it might be as simple as not having ticked that option when reconfiguring repository mirroring.

As recommended by the customer in a ticket (internal link) adding something to the troubleshooting about this.

Also the other ideas we came up with in the ticket.

I think CI/CD for external repositories uses pull mirroring since its premium, and the mirroring is clearly configured in GitLab, not in (say) GitHub. Given the presence of this configuration, it has to be either pull mirroring or push mirroring, and in this context it's definitely not push mirroring.

The confusion arises from the presence of webhooks for the Github integration, and this is needed for pipelines for pull requests.

This being the case, the documentation for all this functionality is in multiple places:

• https://docs.gitlab.com/ee/user/project/repository/mirror/pull.html#configure-pull-mirroring
• https://docs.gitlab.com/ee/user/project/repository/mirror/
• https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/
• https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/github_integration.html

I've tried to make this findable when using CI/CD for external repositories, while also documenting it for pull mirroring.

Related issues

#346630

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
• 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.2

added docsimprovement documentation grouppipeline execution maintenancerefactor typemaintenance labels

assigned to @bprescott_

added devopsverify sectionci labels

added Support Team Contributions label

	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/ci_cd_for_external_repos/index.md (Link to current live version)
• doc/user/project/repository/mirror/index.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

changed the description

removed docs-only label

added docs-only label

removed docs-only label

added 1 commit

• 4d1fc6f8 - Troubleshoot repository mirroring pipelines

Compare with previous version

changed the description

added docs-only label

Hi @marcel.amirault

This doc change is mainly about "why didn't our pipeline start" - and so even though most of the change is in repository docs, I think it's best reviewed by you.

Also, I'd like your opinion on whether this info is (now) findable from the ci/cd for external repos docs.

requested review from @marcel.amirault