Merge pull request #795 from kay-kim/docs-master

Add docs for ruby driver manual

Author: estolfo

docs/contribute.txt

@@ -0,0 +1,46 @@
+========================
+Contribute to the Driver
+========================
+
+.. default-domain:: mongodb
+
+For Bugs and Feature Requests
+-----------------------------
+
+If you think you have found a bug or want to see a new feature in the
+Ruby driver, please open an issue in `JIRA
+<https://jira.mongodb.org/>`_:
+
+#. `Create a Jira account and login <https://jira.mongodb.org>`_.
+
+#. Navigate to the `Ruby project
+   <https://jira.mongodb.org/browse/RUBY>`_.
+
+#. Click :guilabel:`Create Issue`. Provide as much information as
+   possible about the issue, including:
+
+   - Steps to reproduce it.
+
+   - Version information for the driver and MongoDB.
+
+   - Any applicable code snippets, stack traces and log data. Do not
+     include any sensitive data or server logs.
+
+.. note::
+
+   Bug reports in JIRA for the driver and the Core Server (i.e. **SERVER**)
+   projects are public.
+
+If you identify a security vulnerability in a driver or any other
+MongoDB project, please report it according to the instructions found
+in the :manual:`Create a Vulnerability Report
+</tutorial/create-a-vulnerability-report>`.
+
+Contribute to the MongoDB Ruby Driver
+-------------------------------------
+
+The MongoDB Ruby driver source is located at
+`<https://github.com/mongodb/mongo-ruby-driver>`_.
+
+For instructions in contributing to the driver, see
+`<https://github.com/mongodb/mongo-ruby-driver/blob/master/CONTRIBUTING.md>`_.

docs/includes/older-server-versions-unsupported.rst

@@ -0,0 +1 @@
+The driver does not support older versions of MongoDB.

docs/includes/ruby-driver-compatibility-full-language.rst

@@ -0,0 +1,2 @@
+For additional driver versions, see :ref:`Ruby Driver Language Compatibility Reference  <reference-compatibility-language-ruby>`.
+

docs/includes/ruby-driver-compatibility-full-mongodb.rst

@@ -0,0 +1,2 @@
+For additional driver versions, see :ref:`Ruby Driver MongoDB Compatibility Reference  <reference-compatibility-mongodb-ruby>`.
+

docs/includes/ruby-driver-compatibility-matrix-language.rst

@@ -0,0 +1,6 @@
+The following compatibility table specifies the recommended
+version(s) of the MongoDB Ruby driver for use with a specific version of
+Ruby.
+
+The first column lists the driver version(s).
+

docs/includes/ruby-driver-compatibility-matrix-mongodb.rst

@@ -0,0 +1,6 @@
+The following compatibility table specifies the recommended
+version(s) of the MongoDB Ruby driver for use with a specific version of
+MongoDB.
+
+The first column lists the driver version(s).
+

docs/includes/unicode-checkmark.rst

@@ -0,0 +1 @@
+.. |checkmark| unicode:: U+2713

docs/index.txt

@@ -0,0 +1,67 @@
+.. http://www.mongodb.org/display/DOCS/Ruby+Language+Center
+
+.. _ruby-language-center:
+
+===================
+Ruby MongoDB Driver
+===================
+
+.. default-domain:: mongodb
+
+The MongoDB Ruby driver is the officially supported Ruby driver for
+MongoDB. It is written in pure Ruby and is optimized for simplicity. It
+can be used on its own, but it also serves as the basis of several
+object mapping libraries.
+
+Get Started
+-----------
+
+To get started with the Ruby driver, see :doc:`/installation` and
+:doc:`/quick-start`.
+
+BSON
+----
+
+The Ruby BSON implementation is packaged in a separate gem with C and
+Java extensions for speed depending on the runtime enviroment.
+
+For reference on the Ruby BSON gem, see :doc:`/bson-tutorials`.
+
+Object Mappers
+--------------
+
+Because MongoDB is so easy to use, the basic Ruby driver can be the
+best solution for many applications. But if you need validations,
+associations, and other high-level data modeling functions, then you
+may need Object Document Mapper may be needed.
+
+In the context of a Rails application, an Object Document Mapper
+provides functionality equivalent to, but distinct from, ActiveRecord.
+Because MongoDB is a document-based database, these mappers are called
+Object Document Mappers (ODM) as opposed to Object Relational Mappers
+(ORM).
+
+The ODM officially supported by MongoDB is Mongoid, originally written
+by Durran Jordan.
+
+For tutorials on Mongoid, see :doc:`/mongoid-tutorials`.
+
+.. COMMENT  For the actual build, see mongodb/docs-ruby repo which pulls the documentation source from:
+..    mongo-ruby-driver, 
+..    bson-ruby, and 
+..    mongoid repos.
+
+.. class:: hidden
+
+   .. toctree::
+      :titlesonly:
+
+      installation
+      quick-start
+      ruby-driver-tutorials
+      bson-tutorials
+      mongoid-tutorials
+      API <http://api.mongodb.com/ruby/current/>
+      /reference/driver-compatibility
+      /reference/additional-resources
+      /contribute

docs/installation.txt

@@ -0,0 +1,69 @@
+============
+Installation
+============
+
+.. default-domain:: mongodb
+
+The Ruby driver is bundled as a gem and is hosted on `Rubygems
+<https://rubygems.org/gems/mongo>`_.
+
+.. _ruby-driver-install:
+
+Install the gem
+---------------
+
+The driver can be installed manually or with bundler.
+
+To install the gem manually:
+
+.. code-block:: sh
+
+    gem install mongo
+
+To install the gem with bundler, include the following in your Gemfile:
+
+.. code-block:: ruby
+
+    gem 'mongo', '~> 2.2'
+
+Note the following compatibility matrix to determine if the driver is
+supported on your Ruby version and MongoDB server version.
+
+.. list-table::
+   :header-rows: 1
+   :widths: 28 30 30 30
+
+   * - Ruby Version
+     - MongoDB Server 2.4.x
+     - MongoDB Server 2.6.x
+     - MongoDB Server 3.0.x
+
+   * - 1.8.x
+     - No
+     - No
+     - No
+
+   * - 1.9.x
+     - Yes
+     - Yes
+     - Yes
+
+   * - 2.0.x
+     - Yes
+     - Yes
+     - Yes
+
+   * - 2.1.x
+     - Yes
+     - Yes
+     - Yes
+
+   * - 2.2.x
+     - Yes
+     - Yes
+     - Yes
+
+   * - JRuby 1.7.x
+     - Yes
+     - Yes
+     - Yes