From a563344bc217dffbd64b64fc4cee07dfc4c40692 Mon Sep 17 00:00:00 2001 From: Richard Liaw Date: Thu, 24 Sep 2020 18:09:51 -0700 Subject: [PATCH] [docs] remove ref to google groups -> github discussions (#11019) --- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++-- .github/ISSUE_TEMPLATE/question.md | 14 -------------- CONTRIBUTING.rst | 11 +++++------ README.rst | 19 ++++++++----------- doc/source/_help.rst | 11 +++++++++++ doc/source/cluster/kubernetes.rst | 10 +--------- doc/source/cluster/launcher.rst | 11 +---------- doc/source/cluster/yarn.rst | 11 +---------- doc/source/memory-management.rst | 11 +---------- doc/source/ray-overview/involvement.rst | 9 +++++---- doc/source/tune/_tutorials/_faq.rst | 8 +------- doc/source/tune/key-concepts.rst | 8 +------- doc/source/tune/user-guide.rst | 8 +------- 13 files changed, 40 insertions(+), 97 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 doc/source/_help.rst diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f7cd3f94e..57c46d230 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- -name: Feature request -about: Suggest an idea for Ray, Tune, RLlib, etc. +name: Feature request/Question +about: For feature requests or questions, post on our Github Discussions page instead! title: '' labels: enhancement, triage assignees: '' @@ -10,3 +10,5 @@ assignees: '' ### Describe your feature request + +For feature requests or questions, post on our Github Discussions page instead: https://github.com/ray-project/ray/discussions! diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index dc2dd2ef7..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Question -about: 'Ask a question about Ray usage. For possible bugs, please use the "Bug Report" template instead.' -title: '' -labels: question -assignees: '' - ---- - - - -### What is your question? - -*Ray version and other system information (Python version, TensorFlow version, OS):* diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f0265bcd5..96fa3d68d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,10 +6,9 @@ Reporting bugs and asking questions 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. +1. `Github Discussions`_: For discussions about development, questions about usage, and feature requests. +2. `GitHub Issues`_: For bug reports and feature requests. +3. `StackOverflow`_ To contribute a patch: ---------------------- @@ -22,7 +21,7 @@ To contribute a patch: a git hook that will run the linter before you push your changes. 5. Add new unit tests for your code. -.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev +.. _`Github Discussions`: https://github.com/ray-project/ray/discussions .. _`GitHub Issues`: https://github.com/ray-project/ray/issues .. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray @@ -43,4 +42,4 @@ For contributors who are not in the ray-project organization: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Your PRs will have assignees shortly. Assignees or PRs will be actively engaging with contributors to merge the PR. -- Please actively ping assignees after you address your comments! +- Please actively ping assignees after you address your comments! diff --git a/README.rst b/README.rst index be800b98e..afcec73bf 100644 --- a/README.rst +++ b/README.rst @@ -197,10 +197,10 @@ Ray Serve Quick Start `Ray Serve`_ is a scalable model-serving library built on Ray. It is: -- Framework Agnostic: Use the same toolkit to serve everything from deep - learning models built with frameworks like PyTorch or Tensorflow & Keras +- Framework Agnostic: Use the same toolkit to serve everything from deep + learning models built with frameworks like PyTorch or Tensorflow & Keras to Scikit-Learn models or arbitrary business logic. -- Python First: Configure your model serving with pure Python code - no more +- Python First: Configure your model serving with pure Python code - no more YAMLs or JSON configs. - Performance Oriented: Turn on batching, pipelining, and GPU acceleration to increase the throughput of your model. @@ -292,19 +292,16 @@ More Information Getting Involved ---------------- -- `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. -- `Meetup Group`_: Join our meetup group. +- `Github Discussions`_: For discussions about development, questions about usage, and feature requests. +- `GitHub Issues`_: For reporting bugs. - `Community Slack`_: Join our Slack workspace. - `Twitter`_: Follow updates on Twitter. +- `Meetup Group`_: Join our meetup group. +- `StackOverflow`_: For questions about how to use Ray. -.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev +.. _`Github Discussions`: https://github.com/ray-project/ray/discussions .. _`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 .. _`Meetup Group`: https://www.meetup.com/Bay-Area-Ray-Meetup/ .. _`Community Slack`: https://forms.gle/9TSdDYUgxYs8SA9e8 .. _`Twitter`: https://twitter.com/raydistributed diff --git a/doc/source/_help.rst b/doc/source/_help.rst new file mode 100644 index 000000000..6531ce080 --- /dev/null +++ b/doc/source/_help.rst @@ -0,0 +1,11 @@ +You can post questions or issues or feedback through the following channels: + +1. `Github Discussions`_: For **questions about Ray usage** or **feature requests**. +2. `GitHub Issues`_: For **bug reports**. +3. `Ray Slack`_: For **getting in touch** with Ray maintainers. +4. `StackOverflow`_: Use the [ray] tag **questions about Ray**. + +.. _`Github Discussions`: https://github.com/ray-project/ray/discussions +.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. _`Ray Slack`: https://forms.gle/9TSdDYUgxYs8SA9e8 +.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray diff --git a/doc/source/cluster/kubernetes.rst b/doc/source/cluster/kubernetes.rst index 87f84ddeb..f4cb8d517 100644 --- a/doc/source/cluster/kubernetes.rst +++ b/doc/source/cluster/kubernetes.rst @@ -285,16 +285,8 @@ To delete a running Ray cluster, you can run the following command: Questions or Issues? -------------------- -You can post questions or issues or feedback through the following channels: +.. include:: /_help.rst -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. - -.. _`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 .. _`Kubernetes Horizontal Pod Autoscaler`: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/ .. _`Kubernetes Namespace`: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ diff --git a/doc/source/cluster/launcher.rst b/doc/source/cluster/launcher.rst index 2a6c6d4a0..0b610ac89 100644 --- a/doc/source/cluster/launcher.rst +++ b/doc/source/cluster/launcher.rst @@ -221,13 +221,4 @@ This tells ``ray up`` to sync the current git branch SHA from your personal comp Questions or Issues? -------------------- -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. - -.. _`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 +.. include:: /_help.rst diff --git a/doc/source/cluster/yarn.rst b/doc/source/cluster/yarn.rst index 95615dace..f549806bd 100644 --- a/doc/source/cluster/yarn.rst +++ b/doc/source/cluster/yarn.rst @@ -189,15 +189,6 @@ To clean up a running job, use the following (using the application ID): Questions or Issues? -------------------- -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. - -.. _`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 +.. include:: /_help.rst .. _`Skein`: https://jcrist.github.io/skein/ diff --git a/doc/source/memory-management.rst b/doc/source/memory-management.rst index 8d9fc8f2a..96e4f7e15 100644 --- a/doc/source/memory-management.rst +++ b/doc/source/memory-management.rst @@ -254,13 +254,4 @@ In the above example, the memory quota is specified statically by the decorator, Questions or Issues? -------------------- -If you have a question or issue that wasn't covered by this page, please get in touch via on of 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. - -.. _`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 +.. include:: /_help.rst diff --git a/doc/source/ray-overview/involvement.rst b/doc/source/ray-overview/involvement.rst index 1020debd5..b40276c15 100644 --- a/doc/source/ray-overview/involvement.rst +++ b/doc/source/ray-overview/involvement.rst @@ -1,14 +1,15 @@ Ray is more than a framework for distributed applications but also an active community of developers, researchers, and folks that love machine learning. Here's a list of tips for getting involved with the Ray community: -- Join our `community slack `_ to discuss Ray! The community is extremely active in helping people succeed in building their ray applications. +- Join our `community slack `_ to discuss Ray! - Star and follow us on `on GitHub`_. +- To post questions or feature requests, check out the `Ray Github Discussions`_ page! +- Follow us and spread the word on `Twitter`_! - Join our `Meetup Group`_ to connect with others in the community! - Use the `[ray]` tag on `StackOverflow`_ to ask and answer questions about Ray usage -- Subscribe to `ray-dev@googlegroups.com`_ to join development discussions. -- Follow us and spread the word on `Twitter`_! -.. _`ray-dev@googlegroups.com`: https://groups.google.com/forum/#!forum/ray-dev + +.. _`Ray Github Discussions`: https://github.com/ray-project/ray/discussions .. _`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/tune/_tutorials/_faq.rst b/doc/source/tune/_tutorials/_faq.rst index bc7bc9b3b..bef48b061 100644 --- a/doc/source/tune/_tutorials/_faq.rst +++ b/doc/source/tune/_tutorials/_faq.rst @@ -256,10 +256,4 @@ are efficiently stored and retrieved on your cluster machines. Further Questions or Issues? ---------------------------- -Reach out to us if you have any questions or issues or feedback through the following channels: - -1. `StackOverflow`_: For questions about how to use Ray. -2. `GitHub Issues`_: For bug reports and feature requests. - -.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray -.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. include:: /_help.rst diff --git a/doc/source/tune/key-concepts.rst b/doc/source/tune/key-concepts.rst index 958daae9c..648df7345 100644 --- a/doc/source/tune/key-concepts.rst +++ b/doc/source/tune/key-concepts.rst @@ -257,10 +257,4 @@ Now that you have a working understanding of Tune, check out: Further Questions or Issues? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Reach out to us if you have any questions or issues or feedback through the following channels: - -1. `StackOverflow`_: For questions about how to use Ray. -2. `GitHub Issues`_: For bug reports and feature requests. - -.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray -.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. include:: /_help.rst diff --git a/doc/source/tune/user-guide.rst b/doc/source/tune/user-guide.rst index 57ab549ef..43facb13f 100644 --- a/doc/source/tune/user-guide.rst +++ b/doc/source/tune/user-guide.rst @@ -568,10 +568,4 @@ There are some environment variables that are mostly relevant for integrated lib Further Questions or Issues? ---------------------------- -You can post questions or issues or feedback through the following channels: - -1. `StackOverflow`_: For questions about how to use Ray. -2. `GitHub Issues`_: For bug reports and feature requests. - -.. _`StackOverflow`: https://stackoverflow.com/questions/tagged/ray -.. _`GitHub Issues`: https://github.com/ray-project/ray/issues +.. include:: /_help.rst