https://github.com/mongodb/docs-ruby

MongoDB Ruby Documentation
https://github.com/mongodb/docs-ruby

mongodb nosql ruby

Last synced: 3 months ago
JSON representation

MongoDB Ruby Documentation

• Host: GitHub
• URL: https://github.com/mongodb/docs-ruby
• Owner: mongodb
• Created: 2016-05-31T20:27:56.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-20T18:32:35.000Z (3 months ago)
• Last Synced: 2024-09-27T17:01:39.777Z (3 months ago)
• Topics: mongodb, nosql, ruby
• Language: Python
• Homepage:
• Size: 3.22 MB
• Stars: 5
• Watchers: 47
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
=================================

MongoDB Ruby Driver Documentation

=================================

This repository contains documentation regarding MongoDB Ruby Driver.

Build Locally

-------------

To build the documentation locally, 

- Install `giza `_, if not already

  installed. There is an `installation guide 

  `_ on the MongoDB meta site

  to help you get started.

- Run the following to download and build this documentation locally::

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

Changing Active Versions

------------------------

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.

Contribute

----------

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:

- `Style Guide `_

- `Documentation Practices `_

- `Documentation Organization `_

- `Build Instructions `_

File JIRA Tickets

-----------------

File issue reports or requests at the `Documentation Jira Project

`_.

Ruby Driver Branch List

-----------------------

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

Licenses

--------

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