From 01e18b47f43a00bb554e96b59c7f3a81e05b8f5e Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Wed, 23 Jan 2019 13:30:02 -0800 Subject: [PATCH] Direct people to stackoverflow for questions about usage. (#3830) * Direct people to stackoverflow for questions about usage. * Improve wording --- .github/ISSUE_TEMPLATE.md | 2 ++ CONTRIBUTING.rst | 12 ++++++++---- README.rst | 13 ++++++++----- doc/source/autoscaling.rst | 10 ++++++---- doc/source/contact.rst | 10 ++++++---- doc/source/tune-usage.rst | 10 ++++++---- 6 files changed, 36 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f1e62a1f5b1d..eef0077241e2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,5 +1,7 @@ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d8cdfff08948..eba7aa46c99f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -4,9 +4,12 @@ Contributing to Ray Reporting bugs and asking questions ----------------------------------- -We use `GitHub issues`_ for bug reports and feature requests. For discussions -about development, questions about usage, or any general questions, we use our -mailing list `ray-dev@googlegroups.com`_. +You can post questions or issues or feedback through the following channels: + +1. `ray-dev@googlegroups.com`_: For discussions about development or any general + questions and feedback. +2. `StackOverflow`_: For questions about how to use Ray. +3. `GitHub Issues`_: For bug reports and feature requests. To contribute a patch: ---------------------- @@ -17,5 +20,6 @@ To contribute a patch: 3. Make sure that your code passes the unit tests. 4. Add new unit tests for your code. -.. _`GitHub issues`: https://github.com/ray-project/ray/issues .. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev +.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray diff --git a/README.rst b/README.rst index 15ed3e1003be..95fc99b570bf 100644 --- a/README.rst +++ b/README.rst @@ -73,10 +73,13 @@ More Information Getting Involved ---------------- -- Ask questions on our mailing list `ray-dev@googlegroups.com`_. -- Please report bugs by submitting a `GitHub issue`_. -- Submit contributions using `pull requests`_. +- `ray-dev@googlegroups.com`_: For discussions about development or any general + questions. +- `StackOverflow`_: For questions about how to use Ray. +- `GitHub Issues`_: For reporting bugs and feature requests. +- `Pull Requests`_: For submitting code contributions. .. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev -.. _`GitHub issue`: https://github.com/ray-project/ray/issues -.. _`pull requests`: https://github.com/ray-project/ray/pulls +.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray +.. _`Pull Requests`: https://github.com/ray-project/ray/pulls diff --git a/doc/source/autoscaling.rst b/doc/source/autoscaling.rst index 64d57e0ef687..7f5bf5db9169 100644 --- a/doc/source/autoscaling.rst +++ b/doc/source/autoscaling.rst @@ -295,9 +295,11 @@ Questions or Issues? You can post questions or issues or feedback through the following channels: -1. `Our Mailing List`_: For discussions about development, questions about - usage, or any general questions and feedback. -2. `GitHub Issues`_: For bug reports and feature requests. +1. `ray-dev@googlegroups.com`_: For discussions about development or any general + questions and feedback. +2. `StackOverflow`_: For questions about how to use Ray. +3. `GitHub Issues`_: For bug reports and feature requests. -.. _`Our Mailing List`: https://groups.google.com/forum/#!forum/ray-dev +.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray .. _`GitHub Issues`: https://github.com/ray-project/ray/issues diff --git a/doc/source/contact.rst b/doc/source/contact.rst index c75f25d526d5..361d8512a802 100644 --- a/doc/source/contact.rst +++ b/doc/source/contact.rst @@ -3,9 +3,11 @@ Contact The following are good places to discuss Ray. -1. `Our Mailing List`_: For discussions about development, questions about - usage, or any general questions. -2. `GitHub Issues`_: For bug reports and feature requests. +1. `ray-dev@googlegroups.com`_: For discussions about development or any general + questions. +2. `StackOverflow`_: For questions about how to use Ray. +3. `GitHub Issues`_: For bug reports and feature requests. -.. _`Our Mailing List`: https://groups.google.com/forum/#!forum/ray-dev +.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev .. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray diff --git a/doc/source/tune-usage.rst b/doc/source/tune-usage.rst index 97112c130044..b73298a6f5ac 100644 --- a/doc/source/tune-usage.rst +++ b/doc/source/tune-usage.rst @@ -486,9 +486,11 @@ Further Questions or Issues? You can post questions or issues or feedback through the following channels: -1. `Our Mailing List`_: For discussions about development, questions about - usage, or any general questions and feedback. -2. `GitHub Issues`_: For bug reports and feature requests. +1. `ray-dev@googlegroups.com`_: For discussions about development or any general + questions and feedback. +2. `StackOverflow`_: For questions about how to use Ray. +3. `GitHub Issues`_: For bug reports and feature requests. -.. _`Our Mailing List`: https://groups.google.com/forum/#!forum/ray-dev +.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray .. _`GitHub Issues`: https://github.com/ray-project/ray/issues