Skip to content
GitLab
Next

Style cleanup: future tense

Problem to solve

As @cnorris and I discussed in our 1:1 today, he'd like me to start tackling cleanups of specific tone and style issues in our documentation, one at a time, so we can see focused results. He asked me to start by creating an issue to show the other TWs how to fix the instances of future tense in their docsets, and for me to start scrubbing out instances of future tense across all docsets with the help of the other TWs.

Proposal

  1. Assess the scope of the problem.
  2. Create issues to help delegate out the work, or update this issue to provide repeatable steps for TWs to follow.
  3. Begin cleanup on pages. Clean my own house first, then (time permitting) focus on unowned pages, then help other TWs with theirs.
  4. Achieve goal. Move on to next test.

Who can address the issue

@gl-docsteam, @cnorris asked for each TW to clean up their stages' documentation with these steps:

  1. Edit doc/.vale/gitlab/FutureTense.yml and change line 11 to level: error.

  2. Run the following command from the root directory of the GitLab repo, altering the stage or group name appropriately: grep -riI --files-with-match "stage: STAGENAME" . | xargs vale --no-wrap --minAlertLevel error

  3. Fix the identified issues.

  4. Change the level of FutureTense.yml back to warning.

  5. Assign the MR to @aqualls for review and merge.

  6. Extra credit: tackle some group: unassigned pages.

  7. Check the box when you're done, so we know not to pester you:

Other links/references

  • 2020-11-17: ✖ 5215
  • 2020-11-18: ✖ 4760
  • 2020-12-14: ✖ 2958
Edited by Marcia Ramos