Skip to content

Update admin mode and make it more visible

Ben Prescott_ requested to merge docs/bprescott/20221119-adminmode into master

What does this MR do?

Support had a ticket asking about restricting admin access (internal link) and it took me quite some time to track it down in the documentation.

This change

  1. Links it off the administrator pages and, just there, makes the analogy with sudo.

  2. Documents how to turn off admin mode. This is a little less obvious now it's not in the main UI.

  3. States clearly what the timeout is, since it's coded into the product. Related: #332251

  4. Modifies instructions to reflect the revised UI design; admin mode is now off the main menu and has been renamed slightly.

    • From 5.5:

      image

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.
Edited by Ben Prescott_

Merge request reports

Loading