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.

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

Add Vale linter to CI #201

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

brunoapimentel
Copy link

This linter's purpose is to verify the writing style of the documentation. This PR is currently just a rough draft to test the newly added Github Action.

More info at: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/introduction/

https://vale.sh/docs

Signed-off-by: Bruno Pimentel <bpimente@redhat.com>
Copy link

github-actions bot commented Jan 7, 2025

🚀 Preview is available at https://pr-201--konflux-docs.netlify.app

Comment on lines +1 to +6
name: Linting with Vale
on:
- pull_request
jobs:
vale:
name: Linting with Vale
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: Linting with Vale
on:
- pull_request
jobs:
vale:
name: Linting with Vale
name: Linter
on:
- pull_request
jobs:
vale:
name: Vale

otherwise it shows the same name twice in output, looks weird

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe rename it to linters.yaml ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants