Update our GitLab and SSH documentation
What does this MR do?
Update our GitLab and SSH keys README page. It's a big file (~450 lines), I've updated about the first 250 lines of the file to:
- Describe the basic process in the beginning of the page (with links)
- Clarified the focus on ED25519 and RSA keys (including problems with DSA and ECDSA keys)
- Updated links from blog posts to more "authoritative" sources
- Moved discussion of Windows options towards the end of the page.
I've interspersed notes throughout the doc/ssh/README.md page.
When the build is successful, you'll see the result at this URL: http://docs-preview-ee-27933.178.62.207.141.nip.io/ee/ssh/README.html
I do think the last half of this page could use additional work, but I'm confident that my MR here will help most of our readers.
Related issues
As noted in #207167 (closed), this is the single highest traffic page among ~"devops::access" docs (per FY20-Q4 Total Time on Page (Pageviews x Avg. Time On Page))
Closes !207167
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
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. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.