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 linting to docs as ci check #5623

Merged
merged 508 commits into from
Oct 15, 2024
Merged

add vale linting to docs as ci check #5623

merged 508 commits into from
Oct 15, 2024

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jun 6, 2024

as part of the 2024 epd mentorship, adding vale linting as ci check for our internal and external contributors. this pr also add the vale configuration based on our style guide.

this is a basic configuration that checks for things like:

  • title case headers
  • typos (ignores dbt or data industry words)
  • repeated words
  • and latin abbreviations

@mirnawong1 mirnawong1 requested a review from a team as a code owner June 6, 2024 10:52
Copy link

vercel bot commented Jun 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 8:53am

@github-actions github-actions bot added size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Jun 6, 2024
@github-actions github-actions bot added size: large This change will more than a week to address and might require more than one person and removed size: medium This change will take up to a week to address labels Jun 17, 2024
Copy link
Member

@breezyfasano breezyfasano left a comment

Choose a reason for hiding this comment

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

This lgtm! :shipit: This looks like a really great tool. I like that it's scoped only to markdown files.

Copy link
Contributor

@nghi-ly nghi-ly left a comment

Choose a reason for hiding this comment

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

this is amazing work, @mirnawong1 ! left last comment here https://github.com/dbt-labs/docs.getdbt.com/pull/5934/files#r1784766100

approving!

@mirnawong1 mirnawong1 merged commit 1bb53ea into current Oct 15, 2024
6 checks passed
@mirnawong1 mirnawong1 deleted the test-vale branch October 15, 2024 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants