Skip to content

Document how to use additional local Vale rules

Amy Qualls requested to merge aqualls-idea-second-vale-style into master

What does this MR do?

For some time, I've wanted to ability to use extra Vale rules above and beyond the officially-approved ones we have in doc/.vale/gitlab, without accidentally committing them back upstream. I'm not sure whether the right approach here would be to append to the global .gitignore in the root, or to add a new one in the proposed doc/.vale/local folder. On original submission, this MR contains both.

From everyone else's perspective, doc/.vale/local is empty.

I'd originally hoped to quietly build this for myself and not share it out, but I realized specifying the new local style required a change to .vale.ini.

Sending this over to @eread and @marcel.amirault for thoughts. Tagging @rdickenson as well, because I have a vague memory that he wanted to use a couple of extra rules, too:

  • can you think of any performance issues this might cause?
  • which .gitignore approach is the right one?
  • should I be barking up a wholly different tree instead? Does another solution exist somewhere, given that I've failed to make extra, personal rules Just Work in VS Code?

Thoughts?

To be extra special clear: this idea MR shouldn't merge without talking to more people on the team. I don't want to give the appearance of sneaking this change in.

Related issues

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.
Edited by Amy Qualls

Merge request reports