Docs add noefs mention
What does this MR do?
Adds a note to Gitaly's documentation to advise against using EFS
Related issues
gitlab-com/support/support-team-meta#1499 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
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 and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Merge request reports
Activity
added documentation label
added 506 commits
-
90de2229...14428580 - 504 commits from branch
master
- 812a6305 - Added no efs mention to gitaly.md
- 0108055f - Added noefs mention and fixed merge conflict
-
90de2229...14428580 - 504 commits from branch
1 Warning This merge request does not refer to an existing milestone. 1 Message This merge request adds or changes files that require a review from the Technical Writing team whether before or after merging. Documentation review
The following files will require a review from the Technical Writing team:
doc/administration/high_availability/gitaly.md
Per the documentation workflows, the review may occur prior to merging this MR or after a maintainer has agreed to review and merge this MR without a tech writer review. (Meanwhile, you are welcome to involve a technical writer at any time if you have questions about writing or updating the documentation. GitLabbers are also welcome to use the #docs channel on Slack.)
The technical writer who, by default, will review this content or collaborate as needed is dependent on the DevOps stage to which the content applies:
Tech writer Stage(s) @marcia
~Create ~Release + development guidelines @axil
~Distribution ~Gitaly ~Gitter ~Monitor ~Package ~Secure @eread
~Manage ~Configure ~Geo ~Verify @mikelewis
~Plan To request a review prior to merging
- Assign the MR to the applicable technical writer, above. If you are not sure which category the change falls within, or the change is not part of one of these categories, mention one of the usernames above.
To request a review to commence after merging
- Create an issue for a doc review using the Doc Review template and assign it to the applicable technicial writer from the table.
Reviewer roulette
Changes that require review have been detected! A merge request is normally reviewed by both a reviewer and a maintainer in its primary category (e.g. frontend or backend), and by a maintainer in all other categories.
To spread load more evenly across eligible reviewers, Danger has randomly picked a candidate for each review slot. Feel free to override this selection if you think someone else would be better-suited, or the chosen person is unavailable.
Once you've decided who will review this merge request, mention them as you normally would! Danger does not (yet?) automatically notify them for you.
Category Reviewer Maintainer ~Documentation Evan Read ( @eread
)Generated by
DangerEdited by 🤖 GitLab Bot 🤖mentioned in issue gitlab-com/support/support-team-meta#1499 (closed)
@lyle Ready for review
assigned to @lyle
- Resolved by Evan Read
assigned to @sahbabou
@lyle Regarding the inconsistency in format. I think it might be best to keep them separate, since there's one note about NFS and then another about network.
Do you think we should make both notes a note box? Or should the NFS note match the current format of line 21?
assigned to @lyle
@sahbabou - in the context of Eric/Sid's comment on the original issue, I think it would be best if we keep all the notes about EFS the same across the docs. That way if we do end up having to update Note: it'll be easy to do in all the EFS notes boxes.
So.. let's add do two notes boxes!
assigned to @sahbabou
assigned to @lyle
@lyle I updated the note box and added a : to line 21 so it's consistent with all the other Note:
assigned to @eread
added Support Team Contributions label
changed milestone to %11.10
added Manage [DEPRECATED] label
mentioned in commit 5718b428
added devopsmanage label
mentioned in issue gitlab-org/release/tasks#731 (closed)
added Enterprise Edition label
added typemaintenance label