Skip to content

General style updates to generic OAuth2 page

Craig Norris requested to merge docs-oauth2-update-style into master

What does this MR do?

This MR makes several general style updates to the Sign into GitLab with (almost) any OAuth2 provider page, in an effort to make it more consistent with the other OAuth2 provider pages, including:

  • Updating the page title for consistency with other provider pages.
  • Added a link to the "restart GitLab" content resource in the procedure.
  • Added punctuation to each of the ordered lists.
  • Updated content for readability and style.
  • Updated "single sign-in" references to be consistent.
  • Revised line widths to help with Markdown review and for consistency.

I made every effort to avoid changing any specific content in the page, and focused on making style and readability edits.

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.

Merge request reports