duxet/docs-ecosystem

MongoDB Ecosystem Documentation

MongoDB Ecosystem Documentation

This repository contains documentation regarding components of the MongoDB ecosystem that lay outside of the core server functionality. This documentation builds on the work of the MongoDB Manual <http://docs.mongodb.org/manual/>. You can download and build this documentation locally if you already have Sphinx installed, with the following command:

git clone git://github.com/mongodb/docs-ecosystem
cd docs-ecosystem/
make html

To build on Windows (using Cygwin):

• Ensure you have python installed
• install Sphinx using easy_install -U Sphinx
• install pyyamml using pip install pyyaml
• Build the docs using sphinx-build -b html -d build/doctrees-html -c ./ source build/html

Visit docs/mongodb/build/html/index.html to view the current state of the documentation. You may also wish to install Pygments to provide syntax highlighting for code examples.

To contribute to the documentation please fork this repository on GitHub and issue a pull request. File issue reports or requests at the Documentation Jira Project. See the following documents within this repository that provide a more thorough overview of the documentation style, and process. These links point back to the MongoDB Manual materials:

• Style Guide
• Documentation Practices
• Documentation Organization
• Build Instructions

All documentation is available under the terms of a Creative Commons License.

The MongoDB Documentation Project is governed by the terms of the MongoDB/10gen Contributor Agreement.

If you have any questions, please contact docs@10gen.com.

-- The MongoDB/10gen Docs Team