Docs for web-based commits
What does this MR do and why?
The single single source of truth documentation page to describe the behaviour of web commit signing and the changes to the committer field when web commit signing is enabled.
Related issue: Documentation updates around web-based commit s... (#458202 - closed).
Merge request reports
Activity
changed milestone to %17.1
added Category:Source Code Management documentation groupsource code labels
assigned to @igor.drozdov
added devopscreate sectiondev labels
@msedlakjakubowski @mcbabin @phikai it's the first version of the docs, could you please have a look?
@igor.drozdov Thanks for this as a first pass.
@msedlakjakubowski @igor.drozdov I wonder if we could fit in some version of the description of this merge request. I like how it shows a before and after since I think it helps to understand full what's changing here. We could also extend this to the the other kinds of commits like Web IDE and Merge Commits so that people get a more complete picture. I'm not sure the best way to slot this in, but think it would help really explain things. WDYT?
@igor.drozdov thanks for the work on the documentation!
Do we need to add anything in regards to rotated signing keys (and/or direct transfer and import/export) in this documentation page?
@igor.drozdov Hi! I'm reviewing this today. If you don't mind, I'll commit my fixes directly, so no rebase pls
@phikai I like the before and after from that MR. Let me see about polishing what we have so far, and we can propose adding more via suggestions.
@igor.drozdov I pushed a couple edits + left a few suggestions. Back to you
@igor.drozdov as discussed on our call, the rotated signing keys information is part of https://docs.gitlab.com/ee/administration/gitaly/configure_gitaly.html#configure-commit-signing-for-gitlab-ui-commits. No need to add it to this page. Thank you!
@msedlakjakubowski thanks! Could you please have another look?
@igor.drozdov Thanks, looks good now! Setting to merge. Would you mind opening an MR to add it to docs nav in https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/content/_data/navigation.yaml? I haven't thought about placement yet.
Edit: added in gitlab-docs!4835 (merged)
Edited by Marcin Sedlak-JakubowskiThanks @igor.drozdov and @msedlakjakubowski! Very appreciated
requested review from @msedlakjakubowski, @mcbabin, and @phikai
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/user/project/repository/signed_commits/web_commits.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@igor.drozdov - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
added docs-only label
added featureenhancement typefeature labels
added Technical Writing docsfeature twdoing workflowin review labels
added 2 commits
- Resolved by Igor Drozdov
- Resolved by Igor Drozdov
removed review request for @msedlakjakubowski
mentioned in issue gitaly#5361
- Resolved by Igor Drozdov
added 3516 commits
-
7a96575f...423a14d8 - 3515 commits from branch
master
- 17d6eb65 - Docs for web-based commits
-
7a96575f...423a14d8 - 3515 commits from branch
requested review from @msedlakjakubowski
- Resolved by Marcin Sedlak-Jakubowski
- Resolved by Marcin Sedlak-Jakubowski
- Resolved by Marcin Sedlak-Jakubowski
mentioned in commit 33df8cf4
mentioned in issue #458202 (closed)
added workflowstaging-canary label and removed workflowin review label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
mentioned in merge request gitlab-docs!4835 (merged)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label