Skip to content
Snippets Groups Projects

Docs add noefs mention

Merged Sara Ahbabou requested to merge docs-add-noefs-mention into master
All threads resolved!

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

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • assigned to @sahbabou

  • Author Contributor

    @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?

  • Sara Ahbabou unmarked as a Work In Progress

    unmarked as a Work In Progress

  • Sara Ahbabou changed the description

    changed the description

  • 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

  • Sara Ahbabou added 1 commit

    added 1 commit

    • fd99948c - Added correct syntax for notebox

    Compare with previous version

  • assigned to @lyle

  • Author Contributor

    @lyle I updated the note box and added a : to line 21 so it's consistent with all the other Note:

  • Lyle Kozloff approved this merge request

    approved this merge request

  • Thanks @sahbabou

    @eread - you're up! Tag!

  • assigned to @eread

  • Evan Read changed milestone to %11.10

    changed milestone to %11.10

  • Evan Read approved this merge request

    approved this merge request

  • Evan Read resolved all discussions

    resolved all discussions

  • merged

  • Evan Read mentioned in commit 5718b428

    mentioned in commit 5718b428

  • 🤖 GitLab Bot 🤖 changed the description

    changed the description

  • Please register or sign in to reply
    Loading