This repository contains documentation regarding MongoDB Ruby Driver.
To build the documentation locally,
Install giza, if not already installed.
Run the following to download and build this documentation locally:
git clone git@github.com:mongodb/docs-ruby cd docs-ruby/ make html
The generated HTML will be placed in build/master/html/
.
Note: The build process invokes Sphinx and expects Sphinx's various binaries to be in PATH.
This is done in mongodb/docs-tools repo, see https://github.com/mongodb/docs-tools/commit/6765172dbe5cb60fafd511be000dd99d653ab038 and https://github.com/mongodb/docs-tools/commit/240dac304afbdcfc5c698ebb6a7d260bd14cd48b.
To contribute to the documentation,
- If you have not done so already, please sign the MongoDB Contributor Agreement.
- Fork this repository on GitHub and issue a pull request.
See the following documents that provide an overview of the documentation style and process:
File issue reports or requests at the Documentation Jira Project.
The branch list as well as which is the current one is maintained here: https://github.com/mongodb/docs-tools/blob/master/data/ruby-driver-published-branches.yaml
All documentation is available under the terms of a Creative Commons License.
The MongoDB Documentation Project is governed by the terms of the MongoDB Contributor Agreement.
-- The MongoDB Docs Team