Skip to content

LDAP docs - Consistent indent for example config, one click for the rake task

Ben Prescott_ requested to merge docs/bprescott/20220721-ldapconfig into master

What does this MR do?

1️⃣ The indentation for example LDAP config is really hard to read, and so it's easy to end up with reconfigure failing because there's a missing }

Looking at the example at a high level:

gitlab_rails['ldap_servers'] = {
'main' => {
  'tls_options' => {
  },
  'attributes' => {
  },
  }
}

'tls_options' and 'attributes' are indented the same amount as their closing }, but main is not, and it's the same in the example with multiple LDAP sources.

My reading was that 'lowercase_usernames' => false, and the # EE Only setting are global gitlab_rails['ldap_servers'] settings, but they're not - they're part of main.

2️⃣ After configuring LDAP, to test the configuration, use the LDAP check Rake task. links to a paragraph that says This task is also executed as part of the gitlab:check task, but can run independently. See LDAP Rake Tasks - LDAP Check for details. I'm removing that extra click.

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 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