Release evidence documentation
What does this MR do?
Documentation for #38103 (closed)
Related issues
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.
/label documentation
Merge request reports
Activity
changed milestone to %12.8
assigned to @sean_carroll
mentioned in merge request !23697 (merged)
added documentation label
marked the checklist item Apply the documentation label. as completed
marked the checklist item Follow the Documentation Guidelines and Style Guide. as completed
mentioned in commit bf28382b
mentioned in commit 4392367e
mentioned in commit 374a31fe
assigned to @marcel.amirault
Assigned to @marcel.amirault for review.
added workflowin review label and removed workflowin dev label
@sean_carroll The release stage is @marcia's domain when docs are concerned, as per https://about.gitlab.com/handbook/product/categories/#release-stage, so I'll pass it along to her.
added Technical Writing docsfeature + 1 deleted label
assigned to @marcia and unassigned @marcel.amirault
Thanks @marcel.amirault I will keep it in mind. For some reason your name was suggested when I created the MR.
@marcia there will be a small delay between when evidence collection is scheduled vs when it happens. Should we note this in the documentation?
See also #38103 (comment 259693893)
- Resolved by Sean Carroll
- Resolved by Sean Carroll
- Resolved by Sean Carroll
- Resolved by Sean Carroll
- Resolved by Sean Carroll
- Resolved by Sean Carroll
Awesome, thank you @sean_carroll! I've left a few minor comments, please take a look? Tnx!
cc/ @sselhorn FYI/questions (Sean, she's an onboarding tech writer shadowing me on ~"devops::release").
unassigned @marcia
mentioned in commit 22050471
added 250 commits
-
938f1fcf...691b83eb - 249 commits from branch
master
- 22050471 - Release evidence documentation
-
938f1fcf...691b83eb - 249 commits from branch
Thanks for the suggestions @marcia
Something is wrong with gitlab.com, and I am getting errors when apply suggestions
I have applied all manually, and left one thread unresolved for you to review.Back to you
Edited by Sean CarrollThanks, @sean_carroll :) Lemme ask you smt, is this MR !23697 (merged) introducing the feature we're documenting here? If so, let's add it as a dependency of this MR so that we only merge this once the feature is in.
Thanks @marcia I already set it here ... do I need to do something else?
We've noticed that yesterday too
It seems to be part of a wider issue, but there are people working on it.
It seems to be part of a wider issue, but there are people working on it.
Thanks, Sean. :)
do I need to do something else?
Only remind me (assign this back to me) when that MR gets merged so I can merge this one.
Thank you!
Edited by Marcia Ramos@sean_carroll are we good to go?
@marcia it is good to go. I'm not sure why it didn't automerge as the dependent MR is merged...
Thanks for the review(s)
Thanks, @sean_carroll! Should it merge on its own?
If so, I think we have to update the docs. I don't think they say anything about this.
Edited by Marcia Ramos
assigned to @marcia
- Resolved by Sean Carroll
added docs-only label