# docs-compass

**Repository Path**: mirrors_mongodb/docs-compass

## Basic Information

- **Project Name**: docs-compass
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2023-12-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

=============================
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 `docs@mongodb.com
<mailto:docs@mongodb.com>`_.

-- The MongoDB/10gen Docs Team