Skip to content

Initial proposal for RSA key length wording

Amy Qualls requested to merge aqualls-rsa-key-note into master

What does this MR do?

Follows up Document max RSA key size change (!129191 - merged) to start revising the info in doc/user/ssh.md about RSA key length limitations imposed by Go. That MR needed to go out quickly, so I opted to approve the docs language as-is and revise in a separate MR.

This page belongs to ~"group::authentication and authorization", so it's not one of the usual ones I work on:

  • @ashmckenzie, I'm adding you as a reviewer thanks to your information in !129191 (comment 1514634733). Pass this MR forward to @jglassman1 with your changes; he's the TW for ~"group::authentication and authorization".
  • @jglassman1, tbh I'm muddling around here and don't feel great about my words here. My limited hours mean you get to see a gnarly draft. 😁 There's also discussion in !129191 (merged) about whether or not to do a release post item for this change. Would that be handled by you or me?

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.

Merge request reports