MongoDB Compass Documentation

This repository contains documentation regarding MongoDB Compass. This documentation builds on the work of the MongoDB Manual.

If you already have 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.

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

File issue reports or requests at the Documentation Jira Project.

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 [email protected].

-- The MongoDB/10gen Docs Team