Skip to content

Add Enterprise user domain verification instructions

Cynthia "Arty" Ng requested to merge docs-spt-379838 into master

What does this MR do?

Add instructions on how to view, add, and manage configured domains in the group.

A customer was very upset thinking they had to configure the A record to get verified domain. However, that's not necessary. I decided to add instructions on how to view and manage domains since those were missing.

The instructions will change once we implement #375492 (closed) but all the more so we'll need a specific section of the docs once that feature is done.

Related issues

Related to https://gitlab.zendesk.com/agent/tickets/379838 (internal)

Screenshot

For reference, this is what a domain verification page looks like. It's only available at the top-level group. This one shows how a verified and an unverified domain looks like:

image

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.

Merge request reports