Skip to content

Docs: Improve SCIM documentation

Tristan requested to merge docs-scim-updates into master

What does this MR do?

This MR aims to improve the readability and accuracy of our SCIM configuration documentation based on a recent deepdive that support did on setting up SCIM with Azure and customer feedback. Specifically, it does the following:

  • Reworks the structure of the page so that specific instructions for SCIM configuration of new IdP's other than Azure can be added, the idea being that each provider has its own section. Specific steps to configure Azure are now under a Azure header.
  • Reworks the Azure specific instructions for setting up mappings as the previous instructions didn't account for pitfalls the user will run into when configuring a fresh Azure AD app.
  • Refreshes screenshots and adds two new ones for added clarity.

Related issues

#1634

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Tristan

Merge request reports