From 4b015bdc4e36e22ae8ed8afe59162286e61b5c11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Thu, 19 May 2022 10:25:28 +0200 Subject: [PATCH] docs: move forum to discuss.openedx.org Now that Tutor is the official community installation for Open edX, it no longer makes sense to host a forum that is separate from the general Open edX forum. Moving conversations there will encourage cross-communication between projects and maintainers. This change is part of a larger overhaul described in this Tutor enhancement proposal (TEP): https://discuss.overhang.io/t/tep-rethinking-the-tutor-maintainers-program/2724 In the future, plugin maintainers should point their users to the Open edX forum as well. They are encouraged to create dedicated "tutor-pluginnname" tags on the forum and to set their notification level to "watching". --- .github/ISSUE_TEMPLATE/question.md | 2 +- README.rst | 6 +++--- docs/dev.rst | 2 +- docs/index.rst | 2 +- docs/troubleshooting.rst | 9 +++++---- docs/tutor.rst | 4 ++-- docs/tutorials/index.rst | 3 ++- docs/whatnext.rst | 2 +- setup.py | 2 +- 9 files changed, 17 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 74f40d0..570e640 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -4,6 +4,6 @@ about: This is not the appropriate channel --- -Please post on our forums: https://discuss.overhang.io for questions about using `tutor`. +Please post on our forums: https://discuss.openedx.org/tag/tutor for questions about using `tutor`. Posts that are not a bug report or a feature/enhancement request will not be addressed on this issue tracker. diff --git a/README.rst b/README.rst index f9e8a2a..0d39c6d 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ Tutor: the Docker-based Open edX distribution designed for peace of mind :alt: Source code :target: https://github.com/overhangio/tutor -.. image:: https://img.shields.io/static/v1?logo=discourse&label=Forums&style=flat-square&color=ff0080&message=discuss.overhang.io +.. image:: https://img.shields.io/static/v1?logo=discourse&label=Forums&style=flat-square&color=ff0080&message=discuss.openedx.org :alt: Forums - :target: https://discuss.overhang.io + :target: https://discuss.openedx.org/tag/tutor .. image:: https://img.shields.io/static/v1?logo=readthedocs&label=Documentation&style=flat-square&color=blue&message=docs.tutor.overhang.io :alt: Documentation @@ -82,7 +82,7 @@ Please follow the instructions from the `troubleshooting section `__. + Getting all edx-platform unit tests to pass on Tutor is currently a work-in-progress. Some unit tests are still failing. If you manage to fix some of these, please report your findings in the `Open edX forum `__. diff --git a/docs/index.rst b/docs/index.rst index a08d55b..a92299c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,7 +35,7 @@ :caption: Project links Source code - Community forums + Community forums Pypi releases Changelog diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index e786bc1..5d10416 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -11,9 +11,10 @@ What should you do if you have a problem? 1. Read the error logs that appear in the console. When running a single server platform as daemon, you can view the logs with the ``tutor local logs`` command. (see :ref:`logging` below) 2. Check if your problem already has a solution right here in the :ref:`troubleshooting` section. 3. Search for your problem in the `open and closed Github issues `_. -4. Search for your problem in the `community forums `__. -5. If despite all your efforts, you can't solve the problem by yourself, you should discuss it in the `community forums `__. Please give as many details about your problem as possible! As a rule of thumb, **people will not dedicate more time to solving your problem than you took to write your question**. -6. If you are *absolutely* positive that you are facing a technical issue with Tutor, and not with Open edX, not with your server, not your custom configuration, then, and only then, should you open an issue on `Github `__. You *must* follow the instructions from the issue template!!! If you do not follow this procedure, your Github issues will be mercilessly closed 🤯. +4. Search for your problem in the (now legacy) `Tutor community forums `__. +5. Search for your problem in the `Open edX community forum `__. +6. If despite all your efforts, you can't solve the problem by yourself, you should discuss it in the `Open edX community forum `__. Please give as many details about your problem as possible! As a rule of thumb, **people will not dedicate more time to solving your problem than you took to write your question**. You should tag your topic with "tutor" or the corresponding Tutor plugin name ("tutor-discovery", etc.) in order to notify the maintainers. +7. If you are *absolutely* positive that you are facing a technical issue with Tutor, and not with Open edX, not with your server, not your custom configuration, then, and only then, should you open an issue on `Github `__. You *must* follow the instructions from the issue template!!! If you do not follow this procedure, your Github issues will be mercilessly closed 🤯. Do you need professional assistance with your tutor-managed Open edX platform? Overhang.IO offers online support as part of its `Long Term Support (LTS) offering `__. @@ -23,7 +24,7 @@ Logging ------- .. note:: - Logs are of paramount importance for debugging Tutor. When asking for help on the `Tutor forums `__, **you should always include the unedited logs of your app**. You can get those with:: + Logs are of paramount importance for debugging Tutor. When asking for help on the `Open edX forum `__, **you should always include the unedited logs of your app**. You can get those with:: tutor local logs --tail=100 -f diff --git a/docs/tutor.rst b/docs/tutor.rst index f2f92d6..04e87e3 100644 --- a/docs/tutor.rst +++ b/docs/tutor.rst @@ -99,7 +99,7 @@ Contributing to Tutor Third-party contributions to Tutor and its plugins are more than welcome! Just make sure to follow these guidelines: -- Outside of obvious bugs, contributions should be discussed first in the `official Tutor forums `__. +- Outside of obvious bugs, contributions should be discussed first in the `official Open edX forum `__. - Once we agree on a high-level solution, you should open a pull request on the `Tutor repository `__ or the corresponding plugin. - Make sure that all tests pass by running ``make test`` (see above). - If your PR is in the Tutor core repository, add an item to the CHANGELOG file, in the "Unreleased" section. Use the same format as the other items:: @@ -117,4 +117,4 @@ Happy hacking! ☘️ Joining the team of Tutor Maintainers ------------------------------------- -We have an open team of volunteers who help support the project. You can read all about it `here `__ -- and we hope that you'll consider joining us 😉 +We have an open team of volunteers who help support the project. You can read all about it `here `__ -- and we hope that you'll consider joining us 😉 diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst index 44b46d9..d5128a3 100644 --- a/docs/tutorials/index.rst +++ b/docs/tutorials/index.rst @@ -28,4 +28,5 @@ System administration oldreleases arm64 -Other tutorials can be found in the official Tutor forums, `in the "Tutorials" category `__. +.. Note: maybe we should create a dedicated tutorial category in the Open edX forum? +.. Other tutorials can be found in the official Tutor forums, `in the "Tutorials" category `__. diff --git a/docs/whatnext.rst b/docs/whatnext.rst index 0a628ee..f185605 100644 --- a/docs/whatnext.rst +++ b/docs/whatnext.rst @@ -43,4 +43,4 @@ Check out `Cairn `__, the next-generatio Meeting the community --------------------- -Ask your questions and chat with the Tutor community on the official community forums: https://discuss.overhang.io +Ask your questions and chat with the Tutor community on the official Open edX community forum: https://discuss.openedx.org diff --git a/setup.py b/setup.py index 8debb23..c5ea762 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ setup( "Documentation": "https://docs.tutor.overhang.io/", "Code": "https://github.com/overhangio/tutor", "Issue tracker": "https://github.com/overhangio/tutor/issues", - "Community": "https://discuss.overhang.io", + "Community": "https://discuss.openedx.org/tag/tutor", }, license="AGPLv3", author="Overhang.io",