diff --git a/README.md b/README.md index 385d1917b3..be0ded68fc 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,41 @@ otherwise noted. Please see the for details. Documentation ------------- +------------- Documentation for developers, researchers, and course staff is located in the `docs` subdirectory. Documentation is built using [Sphinx](http://sphinx-doc.org/): you can [view the built documentation on ReadTheDocs](http://docs.edx.org/). +Getting Help +------------ + +If you're having trouble, we have several different mailing lists where you can +ask for help: + +* [openedx-ops](https://groups.google.com/forum/#!forum/openedx-ops): + everything related to *running* Open edX. This includes + installation issues, server management, cost analysis, and so on. +* [openedx-translation](https://groups.google.com/forum/#!forum/openedx-translation): + everything related to *translating* Open edX into + other languages. This includes volunteer translators, our internationalization + infrastructure, issues related to Transifex, and so on. +* [openedx-analytics](https://groups.google.com/forum/#!forum/openedx-analytics): + everything related to *analytics* in Open edX. +* [edx-code](https://groups.google.com/forum/#!forum/edx-code): + everything related to the *code* in Open edX. This includes + feature requests, idea proposals, refactorings, and so on. + +You can also join our IRC channel: [`#edx-code` on Freenode](http://webchat.freenode.net/?channels=edx-code). + +Issue Tracker +------------- + +[We use JIRA for our issue tracker](https://openedx.atlassian.net/), not +GitHub Issues. To file a bug or request a new feature, please make a free +account on our JIRA and create a new issue! + How to Contribute ----------------- @@ -45,8 +73,3 @@ Reporting Security Issues ------------------------- Please do not report security issues in public. Please email security@edx.org - -Mailing List and IRC Channel ----------------------------- - -You can discuss this code on the [edx-code Google Group](https://groups.google.com/forum/#!forum/edx-code) or in the [`edx-code` IRC channel on Freenode](http://webchat.freenode.net/?channels=edx-code). diff --git a/docs/en_us/developers/source/process/contributor.rst b/docs/en_us/developers/source/process/contributor.rst index 9bb0833d62..8b8207130b 100644 --- a/docs/en_us/developers/source/process/contributor.rst +++ b/docs/en_us/developers/source/process/contributor.rst @@ -7,13 +7,13 @@ developers and the rest of the Open edX community to discuss your ideas. There might well be someone else already working on the same change you want to make, and it’s much better to collaborate than to submit incompatible pull requests. You can `send an email to the mailing list`_, `chat on the IRC channel`_, or -open an issue on our Github issue tracker. (We prefer email or IRC rather than -Github issues.) The earlier you start the conversation, the easier it will be to -make sure that everyone’s on the right track -- before you spend a lot of time -and effort making a pull request. +`open an issue in our JIRA issue tracker`_. The earlier you start the +conversation, the easier it will be to make sure that everyone’s on the right +track -- before you spend a lot of time and effort making a pull request. .. _send an email to the mailing list: https://groups.google.com/forum/#!forum/edx-code .. _chat on the IRC channel: http://webchat.freenode.net?channels=edx-code +.. _open an issue in our JIRA issue tracker: https://openedx.atlassian.net It’s also sometimes useful to submit a pull request even before the code is working properly, to make it easier to collect early feedback. To indicate to