Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reorganize README

Browse Source
This commit is contained in:
David Baumgold
2014-08-01 12:19:42 -04:00
parent c9076b6c48
commit 6c70c3a586
1 changed files with 29 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -23,21 +23,42 @@ otherwise noted. Please see the
[`LICENSE`](https://github.com/edx/edx-platform/blob/master/LICENSE) file
for details.
Issue Tracker
-------------
[We use JIRA for our issue tracker](https://openedx.atlassian.net/), not
GitHub Issues. To file a bug, request a new feature, or ask for help, please
make a free account on our JIRA and create a new issue!
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
-----------------
@@ -52,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).