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

[Data] Add Vale configuration #35916

Merged
merged 86 commits into from
Aug 22, 2023
Merged

[Data] Add Vale configuration #35916

merged 86 commits into from
Aug 22, 2023

Conversation

bveeramani
Copy link
Member

@bveeramani bveeramani commented May 31, 2023

Why are these changes needed?

This PR adds configuration for Vale -- a linting tool that helps us enforce a consistent editorial style. To use Vale, either install the VSCode extension for Vale or run vale doc/source/data.

In a future PR, we plan to enforce Vale in CI (starting with the Data documentation).

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

bveeramani and others added 30 commits November 21, 2022 21:00
Signed-off-by: Balaji Veeramani <[email protected]>
This reverts commit de05655.

Signed-off-by: Balaji Veeramani <[email protected]>
@stale
Copy link

stale bot commented Aug 11, 2023

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

  • If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@stale stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Aug 11, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@stale stale bot removed the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Aug 21, 2023
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@bveeramani bveeramani changed the title [Data][CI] Add Vale workflow [Data] Add Vale configuration Aug 21, 2023
@angelinalg
Copy link
Contributor

This literally gives me the warm fuzzies. Thank you so much, @bveeramani and @amogkam!

One request, @bveeramani, is there a way to standardize how we tell readers to "see" another doc, vs "read, go to, check out, etc."

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

Just some nits.

.github/styles/Google/We.yml Show resolved Hide resolved
.github/styles/Vocab/General/reject.txt Show resolved Hide resolved
.github/styles/Google/Will.yml Show resolved Hide resolved
.github/styles/Google/Acronyms.yml Show resolved Hide resolved
@amogkam
Copy link
Contributor

amogkam commented Aug 21, 2023

All credit goes to @bveeramani! Great work!

Copy link
Contributor

@amogkam amogkam left a comment

Choose a reason for hiding this comment

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

data doc changes lgtm

.github/styles/Google/EnDash.yml Outdated Show resolved Hide resolved
Address review comments

Signed-off-by: Balaji Veeramani <[email protected]>
Update dashes

Signed-off-by: Balaji Veeramani <[email protected]>
Remove trailing newine

Signed-off-by: Balaji Veeramani <[email protected]>
@bveeramani bveeramani merged commit b60a484 into ray-project:master Aug 22, 2023
1 of 2 checks passed
@bveeramani bveeramani deleted the vale branch August 22, 2023 20:08
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
This PR adds configuration for Vale -- a linting tool that helps us enforce a consistent editorial style. To use Vale, either install the VSCode extension for Vale or run vale doc/source/data.

In a future PR, we plan to enforce Vale in CI (starting with the Data documentation).

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: e428265 <[email protected]>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
This PR adds configuration for Vale -- a linting tool that helps us enforce a consistent editorial style. To use Vale, either install the VSCode extension for Vale or run vale doc/source/data.

In a future PR, we plan to enforce Vale in CI (starting with the Data documentation).

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Victor <[email protected]>
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.

3 participants