From 54996e96903e63ec24e3f61d7e9234720a64c68c Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Wed, 11 Sep 2013 09:36:49 -0400 Subject: [PATCH] Docs: phase out mailing list as a support channel --- CONTRIBUTING.md | 2 +- src/sphinx/Community/Opportunities.rst | 2 +- src/sphinx/Community/index.rst | 4 +--- src/sphinx/Getting-Started/Summary.rst | 5 ++--- src/sphinx/_sphinx/themes/sbt/layout.html | 2 +- src/sphinx/conf.py | 2 +- src/sphinx/faq.rst | 10 ++++++---- src/sphinx/home.rst | 5 +++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a35e16a4..e7e21b833 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Please use the issue tracker to report confirmed bugs. Do not use it to ask questions. -If you are uncertain whether something is a bug, please ask on the mailing list first. +If you are uncertain whether something is a bug, please ask on StackOverflow or the sbt-dev mailing list first. When opening a new issue, diff --git a/src/sphinx/Community/Opportunities.rst b/src/sphinx/Community/Opportunities.rst index 2ba1a0000..e8a8c2847 100644 --- a/src/sphinx/Community/Opportunities.rst +++ b/src/sphinx/Community/Opportunities.rst @@ -3,7 +3,7 @@ Opportunites ============ Below is a running list of potential areas of contribution. This list -may become out of date quickly, so you may want to check on the `mailing list`_ +may become out of date quickly, so you may want to check on the `sbt-dev mailing list`_ if you are interested in a specific topic. 1. There are plenty of possible visualization and analysis diff --git a/src/sphinx/Community/index.rst b/src/sphinx/Community/index.rst index 5d27d0628..2227d1cf2 100644 --- a/src/sphinx/Community/index.rst +++ b/src/sphinx/Community/index.rst @@ -5,9 +5,7 @@ Community This part of the documentation has project "meta-information" such as where to find source code and how to contribute. -The mailing list is at -http://groups.google.com/group/simple-build-tool/topics. Please use it -for questions and comments! +See :ref:`Getting Help ` for information on sbt on StackOverflow, the development mailing list, and irc. .. toctree:: :maxdepth: 1 diff --git a/src/sphinx/Getting-Started/Summary.rst b/src/sphinx/Getting-Started/Summary.rst index 041fb12e2..0673696ec 100644 --- a/src/sphinx/Getting-Started/Summary.rst +++ b/src/sphinx/Getting-Started/Summary.rst @@ -50,9 +50,8 @@ sbt: The Core Concepts - add plugins with the `addSbtPlugin` method in `project/plugins.sbt` (NOT `build.sbt` in the project's base directory). -If any of this leaves you wondering rather than nodding, please ask for -help on the `mailing list`_, go -back and re-read, or try some experiments in sbt's interactive mode. +If any of this leaves you wondering rather than nodding, please :ref:`ask for help `, +go back and re-read, or try some experiments in sbt's interactive mode. Good luck! diff --git a/src/sphinx/_sphinx/themes/sbt/layout.html b/src/sphinx/_sphinx/themes/sbt/layout.html index d0469359e..70a736f73 100644 --- a/src/sphinx/_sphinx/themes/sbt/layout.html +++ b/src/sphinx/_sphinx/themes/sbt/layout.html @@ -31,7 +31,7 @@ {%- endif %}
  • Documentation
  • Download
    • -
  • Mailing List
    • +
  • Mailing List
  • Project
    • diff --git a/src/sphinx/conf.py b/src/sphinx/conf.py index 293080816..02968ac13 100644 --- a/src/sphinx/conf.py +++ b/src/sphinx/conf.py @@ -91,7 +91,7 @@ rst_epilog = """ .. _DEB: %(sbt_native_package_base)s%(release)s/sbt.deb .. _RPM: %(sbt_native_package_base)s%(release)s/sbt.rpm .. |nightly-launcher| replace:: <%(launcher_snapshots_base)s -.. _mailing list: http://groups.google.com/group/simple-build-tool/topics +.. _sbt-dev mailing list: https://groups.google.com/forum/#!forum/sbt-dev .. _adept: https://groups.google.com/group/adept-dev/topics .. _sbt-launcher-package: https://github.com/sbt/sbt-launcher-package .. _Stack Overflow: http://stackoverflow.com/tags/sbt diff --git a/src/sphinx/faq.rst b/src/sphinx/faq.rst index 7c6d2fad8..544b909ab 100644 --- a/src/sphinx/faq.rst +++ b/src/sphinx/faq.rst @@ -4,10 +4,12 @@ Frequently Asked Questions Project Information ------------------- +.. _getting-help: + How do I get help? ~~~~~~~~~~~~~~~~~~ -Please use `Stack Overflow`_ for questions. Use the `mailing list`_ for comments and discussions. +Please use `Stack Overflow`_ for questions. Use the `sbt-dev mailing list`_ for comments and discussions about sbt development. - Please state the problem or question clearly and provide enough context. Code examples and build transcripts are often useful when @@ -21,8 +23,8 @@ How do I report a bug? ~~~~~~~~~~~~~~~~~~~~~~ Please use the `issue tracker `_ -to report confirmed bugs. Do not use it to ask questions. If you are -uncertain whether something is a bug, please ask on the `mailing list`_ first. +to report confirmed bugs. Do not use it to ask questions or to determine +if something is a bug. See :ref:`getting-help`. How can I help? ~~~~~~~~~~~~~~~ @@ -31,7 +33,7 @@ How can I help? - Make `bug reports `_ that are clear and reproducible. - Answer questions on `Stack Overflow`_. -- Discuss development on the `mailing list`_. +- Discuss development on the `sbt-dev mailing list`_. - Fix issues that affect you. `Fork, fix, and submit a pull request `_. - Implement features that are important to you. There is an diff --git a/src/sphinx/home.rst b/src/sphinx/home.rst index be4e0787f..9bd517f1b 100644 --- a/src/sphinx/home.rst +++ b/src/sphinx/home.rst @@ -41,8 +41,9 @@ To get started, *please read* the :doc:`Getting Started Guide `. -`Stack Overflow `_ is preferred for questions. -The `mailing list`_ can be used for comments, discussions, and questions. +Use `Stack Overflow `_ for questions. +Use the `sbt-dev mailing list`_ for discussing sbt development. +Use the #sbt irc channel for questions and discussions. This documentation can be forked `on GitHub `_. Feel free to make corrections and add documentation.