From 5c78a47ea96fae0b12802bff7ebf44a28de8137b Mon Sep 17 00:00:00 2001 From: Julia Silge Date: Mon, 4 Nov 2024 17:59:38 -0700 Subject: [PATCH] Update info on linter --- .github/workflows/lint.yml | 1 + README.md | 5 +---- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index ce6df85..a9a7fdf 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -14,4 +14,5 @@ jobs: with: fail_on_error: true filter_mode: nofilter + reporter: github-pr-review token: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/README.md b/README.md index 963a916..b5d209e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,4 @@ This project uses [Vale](https://vale.sh/docs/) for automated linting and compli - If you are a Posit employee, you can find the "Posit Documentation Style Guide" on Confluence. - If you are an external contributor, we as reviewers will take responsibility for compliance with the guidelines. Thank you for being willing to improve our docs! -Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally. - -- First, use `quarto render` to generate the HTML that can be linted. -- Then, run `vale _site/` to lint the HTML generated by Quarto. +Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally. Run `vale .` from the root directory of this project to lint the `.qmd` files used to build to site.