This is the documentation for The Coral Project, an initative by the Mozilla Foundation in partnership with The New York Times, and The Washington Post to build an open source comment moderation system for newsrooms and media sites.
Please report bugs and corrections via GitHub issues in this repository.
Our live documentation lives at https://docs.coralproject.net.
Make all documentation changes to the markdown files in the docs_dir directory.
Documentation is built with mkdocs, a static document generator.
To build the documentation:
- Verify that you have python and pip installed on your local or virtual machine (version numbers may vary):
python --version && pip --version
Here are a few ways you can install python and pip:
- a direct install of pip for a direct install
- via a package manager like Homebrew for OSX, Ubuntu's apt-get and others - Quora - How is Homebrew different from apt-get or Yum?
-
git clone this repository to a local development folder.
-
Install mkdocs and associated themes, dependencies and extensions:
pip install mkdocspip install mkdocs-material -
Install the mkdocs themes that
-
Build the documentation from the root directory of this repo.
mkdocs build --clean -
Start a branch on your system, make your awesome contributions, commit them via git and submit a pull request.
-
Your contributions will be peer reviewed and merged with the master branch.
-
There is a script connecting github to the AWS S3/Cloudfront hosting area via an Iron.io worker.
Upon a successful update to master, it triggers an update to wipe the existing site files and copy over a new set which will appear at https://docs.coralproject.net within 2-3 minutes. This script information can be found in the docsync directory for details.
There is a development environment mirroring production which can be viewed at https://testdocs.coralproject.net