Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vale-linter-update #263

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Vale-linter-update #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e0d19b5
Update linter
RCheesley Feb 2, 2025
496f2f8
Add deliberate issue on committed file
RCheesley Feb 2, 2025
86fc482
Merge branch 'main' into vale-linter-update
RCheesley Feb 2, 2025
4c4a1be
Fix yaml
RCheesley Feb 2, 2025
f67f0a8
Merge branch 'vale-linter-update' of https://github.com/RCheesley/mau…
RCheesley Feb 2, 2025
eb6aacf
Use vale linter
RCheesley Feb 2, 2025
e307d2a
Fix my vale errors
RCheesley Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/workflows/linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ jobs:
run: pip3 install -r docs/requirements.txt

- name: Vale
uses: errata-ai/vale-action@reviewdog
uses: errata-ai/vale-action@v2.1.1
with:
files: docs/
reporter: github-pr-check
filter_mode: added
# Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
version: 3.7.1
files: docs/
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}

build:
runs-on: ubuntu-latest
Expand Down
5 changes: 2 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Mautic Community Handbook
Mautic Community handbook

Check warning on line 1 in docs/index.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Mautic Community handbook' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Mautic Community handbook' should use sentence-style capitalization.", "location": {"path": "docs/index.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
#########################

This handbook is a central point of call for understanding the management and organization of the Mautic community.

The vision is that it grows over time as the teams and governance structure evolves, with team members adding useful resources and updating processes incrementally.

The vision is that it grows over time as the teams and governance structure evolves, with team members adding useful resources and updating processes incrementally. Please feel free to make a PR to add or update content, which the Community and Education teams review and merge.
.. note::

This project is under active development as the handbook is re-platformed from the old system.
Expand Down
Loading