Create new subheading for commit verification errors
What does this MR do?
In !96305 (comment 1093765631) I noted to @brianjaustin that his work exposed some information about the various error states a user could encounter when trying to verify a commit signed with either GPG or X.509. In #381347 (closed) I got extra information about how to resolve each problem.
Questions remaining for engineering:
-
While I added a troubleshooting section to the end of https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/ I am less certain about where to add info in https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/ because a long troubleshooting section already exists on that page. Where does this info fit into the process? -
Should the x509 page be the SSOT of the table of errors/remedies, or should the GPG page be it?
Related issues
- Closes Follow-up from "GraphQL: add commit signature f... (#381347 - closed)
- Related to GraphQL: add commit signature field (!96305 - merged) which provided the basis for this work
- Related to GraphQL: Migrate `signatureHtml` to structured ... (#362728 - closed) which is the parent of #381347 (closed)
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 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.