Add version history for SSH key usage types
What does this MR do?
This merge request is a first attempt to catch up with the changes of #383046 (closed), which went out in !106176 (merged) with no docs. (@tlinz, this merge request is a good example of why I need to know about feature flag merge requests, but in fairness, it's VERY easy to miss something in the December milestone because so many people are out.)
This MR has two problems:
-
Blurred lines between groups. The feature described here blurs the lines between groupsource code and ~"group::authentication and authorization". The engineering work was done by Source Code, but the page belongs to ~"group::authentication and authorization". The
ssh_key_usage_types
feature flag came and went within a single milestone, so I think we're safe in not documenting it. However, now that it's gone, we should consider what other changesdoc/user/ssh.md
needs. We likely need to talk about this new scope in more detail, how it can be used, and what it requires, but … - Amy is still not fully caught up from sick leave. I'm still sifting through what happened during vacation-followed-by-Covid. I promised @dianalogan in last week's 1:1 that if I could hand off any work, I would. I don't know if @jglassman1 has bandwidth to pick up the rest of the work, and I'm hesitant to ask, but I don't know this docset well.
What I'll do here is assign this small MR review over to Jon. I intentionally kept it small, so I could also use it as a discussion point for finishing up the rest of the feature work.
Related issues
- Related to [Feature flag] Rollout of `ssh_key_usage_types` (#383046 - closed)
- Related to [Feature flag] Cleanup `ssh_commit_signatures` (#384202 - closed)
- Related to Cleans up `ssh commit signatures` ~"feature flag" (!106176 - merged) where the flag changes got merged sans docs
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.