Skip to content

Add Vale to .tool-versions file

Evan Read requested to merge eread/add-vale-to-tool-versions-file into master

What does this MR do?

Like we're now doing in the gitlab project: https://gitlab.com/gitlab-org/gitlab/-/blob/a891058bb057e7b40513d3c081782ac8f507567b/.tool-versions, we can manage the version of Vale people use. Sometimes the latest version is too far ahead of our pipeline configuration, where we do pin the version: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/333454cedc044729748190a904b48c98e2089178/.gitlab-ci.yml#L25.

Previously, we relied on people brew installing Vale or similar.

CC @marcel.amirault @axil

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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 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.
    • 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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports