Skip to content

Add asdf-managed Vale

Evan Read requested to merge eread/add-asdf_managed-vale into master

What does this MR do?

In the past, we've had folks that run Vale install it themselves. Very rarely have their been breaking changes and so this has worked well.

Now, the author of Vale is releasing more and more changes that make previously working tests break. So we need to consider pining the version of Vale like we do most other documentation-related software.

Fortunately, there is now a Vale plugin for asdf: https://github.com/pdemagny/asdf-vale so we can fix the version of Vale we want to that we define for our CI/CD plugins: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/d4a87443d5d1c003475df94111908795cb8633f1/.gitlab-ci.yml#L25.

Author's checklist

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 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 reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports