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

[CI] Enforce Vale on Data documentation #39029

Merged
merged 10 commits into from
Aug 31, 2023
Merged

Conversation

bveeramani
Copy link
Member

@bveeramani bveeramani commented Aug 28, 2023

Why are these changes needed?

Vale is a linter for writing style. This PR enforces Vale on the Data documentation.

Related issue number

See #35916

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 :(

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@bveeramani bveeramani marked this pull request as draft August 28, 2023 22:56
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
ci/lint/check-documentation-style.sh Outdated Show resolved Hide resolved
ci/lint/check-documentation-style.sh Outdated Show resolved Hide resolved
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@aslonnie aslonnie self-requested a review August 30, 2023 01:26
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@bveeramani bveeramani marked this pull request as ready for review August 30, 2023 19:16
@bveeramani bveeramani changed the title [CI] Enforce Vale on data documentation [CI] Enforce Vale on Data documentation Aug 30, 2023
Copy link
Collaborator

@aslonnie aslonnie left a comment

Choose a reason for hiding this comment

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

looks great.

@bveeramani bveeramani merged commit 0fe400a into ray-project:master Aug 31, 2023
103 of 109 checks passed
@bveeramani bveeramani deleted the vale-ci branch August 31, 2023 17:54
LeonLuttenberger pushed a commit to jaidisido/ray that referenced this pull request Sep 5, 2023
Vale is a linter for writing style. This PR enforces Vale on the Data documentation.

Signed-off-by: Balaji Veeramani <[email protected]>
harborn pushed a commit to harborn/ray that referenced this pull request Sep 8, 2023
Vale is a linter for writing style. This PR enforces Vale on the Data documentation.

Signed-off-by: Balaji Veeramani <[email protected]>
jimthompson5802 pushed a commit to jimthompson5802/ray that referenced this pull request Sep 12, 2023
Vale is a linter for writing style. This PR enforces Vale on the Data documentation.

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Jim Thompson <[email protected]>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Vale is a linter for writing style. This PR enforces Vale on 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.

None yet

4 participants