Document invalid metadata deletions being default enabled
What does this MR do?
Praefect has default enabled invalid metadata deletion. Document this fact.
Related issues
gitaly#4429 (comment 1257330331)
gitaly#4429 (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 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.
Merge request reports
Activity
changed milestone to %15.9
added Category:Gitaly docsimprovement documentation groupgitaly maintenancerefactor sectioncore platform typemaintenance + 1 deleted label
assigned to @samihiltunen
mentioned in merge request gitaly!5321 (merged)
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/administration/gitaly/praefect.md
(Link to current live version) -
doc/update/index.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-
added 1 commit
- 0c3a4435 - Document invalid metadata deletions being default enabled
added 1673 commits
-
0c3a4435...c7855673 - 1670 commits from branch
master
- 1e599667 - Update documentation to match Praefect's new configuration structure
- 1850c73a - Add migration instructions for Praefect's new configuration
- 0b85f349 - Document invalid metadata deletions being default enabled
Toggle commit list-
0c3a4435...c7855673 - 1670 commits from branch
mentioned in issue gitaly#4429 (closed)
- Resolved by Toon Claes
@eread this depends on !110379 (merged) given it touches some of the same text but could you review this already ahead of the pre-requisite getting merged? Thanks a lot!
Only the last commit is new in this MR.
requested review from @eread
requested review from @jcaigitlab
mentioned in merge request !110784 (merged)
added 1 commit
- 278228f1 - Document invalid metadata deletions being default enabled
added 1 commit
- 994177bd - Document invalid metadata deletions being default enabled
added 1 commit
- ba906c5e - Document invalid metadata deletions being default enabled
added 1 commit
- c850bb5f - Document invalid metadata deletions being default enabled
- Resolved by Sami Hiltunen
- Resolved by Toon Claes
thanks for this update @samihiltunen! had a couple of suggestions for your consideration, but nothing blocking.
removed review request for @eread
added 1 commit
- f79ebfc0 - Document invalid metadata deletions being default enabled
@eread This should also be ready to go along with !110379 (merged)
added 1882 commits
-
f79ebfc0...68262cec - 1881 commits from branch
master
- 7e8e7662 - Document invalid metadata deletions being default enabled
-
f79ebfc0...68262cec - 1881 commits from branch
!110379 (merged) was merged, and proper approvals were given. Merging.
enabled an automatic merge when the pipeline for 1335dea2 succeeds
mentioned in commit 15b151dc
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label