kuyesu / edx-developer-docs

Words that developers want to read

edx-developer-docs

Overview

This repository contains any cross-repository Open edX developer documentation. It also includes references to other developer documentation.

Documentation

The full documentation is at https://edx-developer-docs.readthedocs.org.

Testing

To test documentation changes locally, run through the following.

Install the requirements inside of a Python virtualenv.

make requirements

Then run all tests as they will be run against your PR.

make test-all

Note: Look for warnings, which will not fail the test but are useful to clean up.

Alternatively, build the docs which should load them in your browser.

make docs

Lastly, if you want to test external links (from the docs directory).

cd docs
make linkcheck

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md

Reporting Security Issues

Please do not report security issues in public. Please email [email protected].

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.