Also:

- Remove some white space from end of line
- Document using markdownlint-cli2

This reverts merge request !106469

Sarah German authored 2 years ago and David O'Regan committed 2 years ago

This reverts commit 2c57d286.

When tweaking the docs pipeline, we should always run the
docs lint jobs, and should always lint all files.

Also disables new rules made available in new version until
documentation can be made to pass.

Also make minor documentation updates to trigger jobs to test new images

Also share logic between Lefthook and lint-doc.sh script.

This reverts merge request !59228

Marcel Amirault authored 3 years ago and Vitaly Slobodin committed 3 years ago

Also updates links to new target docs

Otherwise our script will fail if a file gets deleted.

Amy Qualls authored 4 years ago and Craig Norris committed 4 years ago

Add the rudiments of a test that flags Markdown files in the doc/
directory that do not have front matter. Files without front matter
won't show up in the Technical Writing team's calculations.

Marcel Amirault authored 4 years ago and Evan Read committed 4 years ago

We prefer index files now. Updates lint-doc
to match.

Amy Qualls authored 4 years ago and Evan Read committed 4 years ago

Copy and modify existing code to start moving toward a workable
test for NBSP and NNBSP characters.

Marcel Amirault authored 4 years ago and Rémy Coutable committed 4 years ago

If vale or markdownlint are updated, we should
run on all files.

Marcel Amirault authored 4 years ago and Evan Read committed 4 years ago

We can shrink the docker image if we don't need ruby

Add an extra clause to the lint-doc.sh script and check if the list of
markdown files is empty when a merge results pipeline is run. If it is,
skip the markdownlint check altogether.

Amy Qualls authored 4 years ago and Rémy Coutable committed 4 years ago

This commit creates a new .vale.py file in the root folder. It
breaks Vale's output apart into multiple lines, making it easier to
read the output. It also adds a new line that links back to the
style guide, explaining how to fix the error.

It's dangerous when `cd` fails but following commands keeps running
which would lead to expected results.

For those shell scripts without `set -e`, use `exit 1` before furthur
refactor could be a safe and efficient workaround, for thoes shell
scripts with `-e`, the shell(script) will exit immediately if any
command has a non-zero exit status, so they don't need `exit 1`

Reference:
- https://github.com/koalaman/shellcheck/wiki/SC2164

Marcel Amirault authored 4 years ago and Evan Read committed 4 years ago

Remove redirect files that were put in years
ago, and start using server-side redirects

Marcel Amirault authored 4 years ago and Achilleas Pipinellis committed 4 years ago

All files in these directories are redirected and no longer
needed.

All files are redirect files. Remove them in
favor of new server-side redirects

Check what type of pipeline is running. If it's a merged
results pipeline, use CI variables to determine the
merge-base. Use git diff with merge-base to see what files
changes, filtering on markdown files, then run vale and
markdownlint on only those changed files.