GithubHelp home page GithubHelp logo

docs-ruby's Introduction

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,

See the following documents that provide an overview of the documentation style and process:

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

docs-ruby's People

Contributors

kay-kim avatar p avatar steveren avatar terakilobyte avatar i80and avatar schmalliso avatar p-mongo avatar macdaddynyc-mongo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.