https://github.com/mongodb/docs-compass
https://github.com/mongodb/docs-compass
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/mongodb/docs-compass
- Owner: mongodb
- Created: 2016-02-18T18:24:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T20:41:41.000Z (about 2 months ago)
- Last Synced: 2025-04-01T16:16:59.370Z (about 1 month ago)
- Language: Python
- Size: 56.7 MB
- Stars: 18
- Watchers: 22
- Forks: 76
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
=============================
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