Skip to content

CTRT: Refactor the SSL docs

Achilleas Pipinellis requested to merge docs-axil-ctrt-refactor-ssl into master

What does this MR do?

Refactor the SSL docs to follow the CTRT guidelines.

  • Given the chance, I also moved all the HTTPS-related content from nginx.md to ssl.md. It's now all in one place.
  • I removed the old references to GitLab 10 release!
  • All gitlab.rb changes now have steps

After this MR, we also need to move the troubleshooting section to its own doc. I saw we already have https://docs.gitlab.com/ee/administration/troubleshooting/ssl.html on its own, so we'll need to find those two a new home.

Related issues

technical-writing#579 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Achilleas Pipinellis

Merge request reports