Docs enforce capitalization and US spelling #57504
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
|
We are closing this PR due to inactivity. We regularly close PRs that were created more than 6 months ago. If you'd like to keep working on it, please feel free reopen it. We'd be happy to keep working with you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This is a small update to our Markdownlint and Vale linter rules for docs. It enforces US spelling, enforces that sentences start with a capital letter, and loosens/exempts some rules that were causing a bunch of false positives.
How
Review guide
These are pretty straightforward text files. Not much to see. There's a bug in Vale that prevented me from targeting multiple types of elements with the capitalization rule, which is why I had to create 4 largely similar ones, one for each element.
See https://docs.airbyte.com/contributing-to-airbyte/writing-docs#linting if you want to learn more about how these work.
User Impact
None yet. I should be the only person using these rules during this testing phase.
Can this PR be safely reverted and rolled back?