Skip to content

CTRT edits for Azure page - part 1

Kati Paizee requested to merge kpaizee-azure-ctrt-edits-1 into master

What does this MR do?

CTRT edits for the Microsoft Azure page:

  • Added intro content, and moved some of the info in the note to the intro.
  • Added two task-based sections:
    • Register an application
    • Enable Microsoft OAuth in GitLab
  • Changed the bulleted list to steps (where appropriate) or incorporated that info elsewhere.
  • Tidied the task steps.

The content after 'Microsoft Azure OAuth 2.0 OmniAuth Provider v2' will be addressed in a second MR.

Before: https://docs.gitlab.com/ee/integration/azure.html

After: http://main-ee-81990.178.62.207.141.nip.io/ee/integration/azure.html

Related issues

technical-writing#531 (closed)

Author's checklist

If you are 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.

Review 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.
    • 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.
  • Ensure a release milestone is set.
Edited by Kati Paizee

Merge request reports

Loading