hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 02:21:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Point to latest contributing doc (#25149)

Browse source 
Pointing to the latest documentation for contributor is important as the workflow is always evolving. E.g. the installation instructions for bazel are not representatives of the current state on release vs master. Hence, I propose to update contribution links in the documentation to point to the latest state on master.
This commit is contained in:
Pamphile Roy 2022-05-31 10:13:20 +02:00 • committed by GitHub
parent 94557e3095
commit 2da2cb8cdf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/source/_includes/_latest_contribution_doc.rst Normal file
View file

@ -0,0 +1,6 @@
.. admonition:: Check your version!
Things can change quickly, and so does this contributor guide.
To make sure you've got the most cutting edge version of this guide,
go check out the
`latest version <https://docs.ray.io/en/master/ray-contribute/getting-involved.html>`__.

7
doc/source/index.md
View file

@ -103,7 +103,10 @@ Here's a list of tips for getting involved with the Ray community:
```{include} _includes/_contribute.md ```{include} _includes/_contribute.md
``` ```
If you're interested in contributing to Ray, check out our [contributing guide](ray-contribute/getting-involved) If you're interested in contributing to Ray, check out our
[contributing guide for this release](ray-contribute/getting-involved)
or see the
[latest version of our contributing guide](https://docs.ray.io/en/master/ray-contribute/getting-involved.html)
to read about the contribution process and see what you can work on. to read about the contribution process and see what you can work on.
## What documentation resource is right for you? ## What documentation resource is right for you?
@ -170,6 +173,6 @@ Our developer guides will help you get started.
+++ +++
{link-badge}`ray-contribute/getting-involved.html,"Developer Guides",cls=badge-light` {link-badge}`https://docs.ray.io/en/master/ray-contribute/getting-involved.html,"Developer Guides",cls=badge-light`
```` ````

2
doc/source/ray-contribute/getting-involved.rst
View file

@ -1,3 +1,5 @@
.. include:: /_includes/_latest_contribution_doc.rst
.. _getting-involved: .. _getting-involved:
Getting Involved / Contributing Getting Involved / Contributing