============================= MongoDB Compass Documentation

This repository contains documentation regarding MongoDB Compass. This documentation builds on the work of the MongoDB Manual <http://docs.mongodb.org/manual/>_.

If you already have giza <https://pypi.python.org/pypi/giza/>_ installed, you can download and build this documentation locally with the following command::

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

View build/html/index.html to view your current build of the documentation.

To contribute to the documentation, please fork this repository on GitHub and issue a pull request. If you have not done so already, please sign the MongoDB/10gen Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>_.

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 <http://docs.mongodb.org/manual/meta/style-guide>_
• Documentation Practices <http://docs.mongodb.org/manual/meta/practices>_
• Documentation Organization <http://docs.mongodb.org/manual/meta/organization>_
• Build Instructions <http://docs.mongodb.org/manual/meta/build>_

File issue reports or requests at the Documentation Jira Project <https://jira.mongodb.org/browse/DOCS>_.

All documentation is available under the terms of a Creative Commons License <http://creativecommons.org/licenses/by-nc-sa/3.0/>_.

The MongoDB Documentation Project is governed by the terms of the MongoDB/10gen Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>_.

If you have any questions, please contact [email protected] <mailto:[email protected]>_.

-- The MongoDB/10gen Docs Team