Skip to content

Move SAML troubleshooting to separate page

Cynthia "Arty" Ng requested to merge docs-363811 into master

What does this MR do?

Reorganizes SAML troubleshooting content from both self-managed page and SaaS page to a single page as proposed in #363811 (closed).

Notes:

  • I decided to leave SCIM alone for now since that feature is not yet in self-managed.
  • I attempted to focus on the reorganization and only do minimal updates to content to make it relevant for both SM and SaaS.
  • One section I moved to the main SaaS SAML page because it should've been there.
  • Merged/removed a couple of redundant or outdated troubleshooting sections.
  • Tier badging on headings in troubleshooting is unusual but felt like the easiest way to mark if something was only relevant to SM or SaaS.

Related issues

Resolves #363811 (closed).

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 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.
Edited by Cynthia "Arty" Ng

Merge request reports