department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 204 forks source link

GitHub action vale as plain language linter #3916

Closed meganhkelley closed 4 years ago

meganhkelley commented 4 years ago

The MVP of vale as a plain language linter adjacent to the CMS user's workflow (#2233) has been deprioritized (decision documented) in favor of using the GitHub action as a proof of concept.

More context: the initial MVP was begun as part of the workflow of content writers using the Drupal CMS. This makes sense in theory, but because access to the Drupal CMS is still incredibly restricted (2-3 content editors, 1 of whom is VSP's content editor), we hypothesize that we won't actually be catching many VFS team members in this location — and those we would catch are content editors and writers who are primarily self-sufficient re: content reviews. Pivoting the implementation to vets-website will allow us to catch enough VFS team members with these content validations to actually validate whether automated content tests are worth investing further in.

In this epic we are looking to:

User Story

As a VFS team member writing content for VA.gov, I want to see automated content validations, so that I am better able to self-serve and write error-free, plain language content.

Definition of Done

billfienberg commented 4 years ago

Here is a draft PR to add the vale-action to the vets-website repo: https://github.com/department-of-veterans-affairs/vets-website/tree/add-vale-github-action