Skip to content

Docs: remove Vim setup from GitLab install instructions

What does this MR do?

This MR removes the optional Vim setup from "GitLab install by source" instructions.

I have come up with four cases, each of which results in the Vim setup instructions being unnecessary:

  1. user is experienced with Vim and already has it set up (no action needed, instructions have no value)
  2. user is experienced with Vim and doesn't have it set up (user knows how to set it up/can find instructions online, instructions have little value)
  3. user is not experienced with Vim and sets it up (user becomes frustrated using Vim because of the learning curve)
  4. user is not experienced with Vim and won't set it up (no action needed, instructions have no value)

Related issues

Closes #288852 (closed).

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

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

  • 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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports