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 more information about developer tooling for docs contributions #46636

Merged

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Jul 15, 2024

Why are these changes needed?

This PR expands the guidelines for contributing to docs by adding a section about esbonio, a language server for sphinx.

Additionally, docs.ipynb has been converted to docs.md after a discussion with @can-anyscale; there was never any python code being executed in this doc, so there's no reason to have the added complexity of it being a notebook. I also added .virtual_documents/ to the .gitignore for those times when we do need to modify a notebook with jupyterlab.

Related issue number

No issue, but addressed doc-infra need to improving documentation editing and providing a syntax assistant.

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

@peytondmurray peytondmurray force-pushed the improve-doc-contribution-section branch 2 times, most recently from 58961f6 to 8b82ed6 Compare July 19, 2024 20:49
@peytondmurray peytondmurray force-pushed the improve-doc-contribution-section branch from 8b82ed6 to 6d3e331 Compare July 19, 2024 21:09
@peytondmurray peytondmurray added the docs An issue or change related to documentation label Jul 19, 2024
@peytondmurray peytondmurray marked this pull request as ready for review July 19, 2024 21:12
@peytondmurray peytondmurray requested a review from a team as a code owner July 19, 2024 21:12
Copy link
Collaborator

@can-anyscale can-anyscale left a comment

Choose a reason for hiding this comment

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

CC: @angelinalg if you want to review the content

@can-anyscale can-anyscale enabled auto-merge (squash) July 24, 2024 18:08
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jul 24, 2024
@can-anyscale can-anyscale merged commit 425391b into ray-project:master Jul 24, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants