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

Use vale linting for AsciiDoc files #28584

Merged
merged 1 commit into from Oct 18, 2022
Merged

Conversation

ebullient
Copy link
Contributor

  • Add vale configuration and rules to the docs project
  • Create a containerized unit test that makes it easy for developers to run Vale locally

Resolves #28481

@quarkus-bot quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/documentation labels Oct 14, 2022
@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Oct 14, 2022
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

I added a comment related to files you should ignore.

@michelle-purcell
Copy link
Contributor

@ebullient - The rules need to be updated with the latest on the QDOCS sandbox that I added this week. For example, Quarkiverse and Gradle. I also added fixes for 'searchability' and 'findability' false positives this morning. Thanks :-)

@ebullient ebullient force-pushed the docs-vale branch 2 times, most recently from 9aa6043 to 2caf8e2 Compare October 14, 2022 14:55
@quarkus-bot

This comment has been minimized.

@michelle-purcell
Copy link
Contributor

@ebullient - Thanks for updating the Quarkus vale ruleset. I can now see the latest terms that were added last week, for example, "[fF]inability" and "[sS]earchability"... LGTM.

Copy link
Contributor

@michelle-purcell michelle-purcell left a comment

Choose a reason for hiding this comment

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

Approving - checked latest ruleset and it looks good to me.

@gsmet
Copy link
Member

gsmet commented Oct 18, 2022

Rebased.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

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

Let's get this in since @michelle-purcell approved it.

Quarkus Documentation automation moved this from To do to Reviewer approved Oct 18, 2022
@gsmet gsmet added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 18, 2022
@quarkus-bot
Copy link

quarkus-bot bot commented Oct 18, 2022

Failing Jobs - Building b2a37a5

Status Name Step Failures Logs Raw logs
✔️ JVM Tests - JDK 11
JVM Tests - JDK 11 Windows Build ⚠️ Check → Logs Raw logs
✔️ JVM Tests - JDK 17
✔️ JVM Tests - JDK 17 MacOS M1
✔️ JVM Tests - JDK 18

@gsmet gsmet merged commit 0a092ba into quarkusio:main Oct 18, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Oct 18, 2022
@quarkus-bot quarkus-bot bot added this to the 2.14 - main milestone Oct 18, 2022
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 18, 2022
@ebullient ebullient deleted the docs-vale branch October 27, 2022 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dependencies Pull requests that update a dependency file area/documentation
Development

Successfully merging this pull request may close these issues.

Docs: Add Vale linter
3 participants