Skip to content

Add Jira Connect proxy debugging docs

Anton Smith requested to merge docs/debugging-jira-proxy-gitlab-com into master

What does this MR do?

We are still seeing users encounter the Failed to update the GitLab instance error. Despite the efforts of #406650 (closed), customers are still reaching out for assistance.

When users setup the GitLab for Jira app from the Atlassian store and they want to connect their self-managed GitLab instance, they must configure GitLab.com as the Jira Connect Proxy. This creates certain issues for GitLab Support:

  1. Support Engineers new to the Jira app do not immediately think to check GitLab.com for logs because if the customer is using a self-managed instance, under normal circumstances why would you check the GitLab.com logs?
  2. How do Support Engineers locate the necessary information to relay to the customer in the GitLab.com logs?
  3. What can customers provide up front to help us debug the problem?

This MR addresses all of those points.

Related issues

Author's checklist

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.

Merge request reports