From 2da2cb8cdf0a2b079830a0061d3522fabbb71a5e Mon Sep 17 00:00:00 2001 From: Pamphile Roy Date: Tue, 31 May 2022 10:13:20 +0200 Subject: [PATCH] Point to latest contributing doc (#25149) 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. --- doc/source/_includes/_latest_contribution_doc.rst | 6 ++++++ doc/source/index.md | 7 +++++-- doc/source/ray-contribute/getting-involved.rst | 2 ++ 3 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 doc/source/_includes/_latest_contribution_doc.rst diff --git a/doc/source/_includes/_latest_contribution_doc.rst b/doc/source/_includes/_latest_contribution_doc.rst new file mode 100644 index 000000000..14b354022 --- /dev/null +++ b/doc/source/_includes/_latest_contribution_doc.rst @@ -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 `__. diff --git a/doc/source/index.md b/doc/source/index.md index daefdedb4..1ae17c943 100644 --- a/doc/source/index.md +++ b/doc/source/index.md @@ -103,7 +103,10 @@ Here's a list of tips for getting involved with the Ray community: ```{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. ## 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` ```` diff --git a/doc/source/ray-contribute/getting-involved.rst b/doc/source/ray-contribute/getting-involved.rst index 83fe8ab54..1cc7ed39f 100644 --- a/doc/source/ray-contribute/getting-involved.rst +++ b/doc/source/ray-contribute/getting-involved.rst @@ -1,3 +1,5 @@ +.. include:: /_includes/_latest_contribution_doc.rst + .. _getting-involved: Getting Involved / Contributing