DOP-4704: Merge mongo-ruby-driver docs history

Author: i80and

source/.gitignore

@@ -0,0 +1 @@
+_build

source/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

source/README.md

@@ -0,0 +1,17 @@
+Ruby MongoDB Driver Documentation
+=================================
+
+This subdirectory contains the high-level driver documentation, including
+tutorials and the reference.
+
+Building the documentation for publishing is done via the
+[docs-ruby repo](https://github.com/mongodb/docs-ruby).
+
+To build the documentation locally for review, install `sphinx` and
+`sphinx-book-theme`, then execute `make html` in this directory:
+
+    pip install sphinx sphinx-book-theme
+    make html
+
+Note that the documentation generated in this manner wouldn't have the
+BSON documentation included, nor are intersphinx links currently handled.

source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Ruby MongoDB Driver'
+copyright = '2021, MongoDB'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+source_suffix = {
+    '.txt': 'restructuredtext',
+}
+
+html_theme = 'sphinx_book_theme'

source/contribute.txt

@@ -0,0 +1,81 @@
+************************
+Contribute to the Driver
+************************
+
+.. default-domain:: mongodb
+
+Report Bugs and Request Ruby Driver-Specific Features
+=====================================================
+
+To report a bug in the driver or request a feature specific to the Ruby driver:
+
+1. Visit `our issue tracker <https://jira.mongodb.org/>`_ and login
+   (or create an account if you do not have one already).
+2. Navigate to the `RUBY project <https://jira.mongodb.org/browse/RUBY>`_.
+3. Click :guilabel:`Create Issue` and fill out all of the applicable form
+   fields.
+
+When creating an issue, please keep in mind that all information in JIRA
+for the RUBY project, as well as the core server (the SERVER project),
+is publicly visible.
+
+**PLEASE DO:**
+
+- Provide as much information as possible about the issue.
+- Provide detailed steps for reproducing the issue.
+- Provide any applicable code snippets, stack traces and log data.
+  Do not include any sensitive data or server logs.
+- Specify version numbers of the driver and MongoDB server.
+
+**PLEASE DO NOT:**
+
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
+
+.. note::
+
+   Bug reports in JIRA for the Ruby driver and the core server (the **SERVER**)
+   projects are public.
+
+If you identified a potential security vulnerability in the Ruby driver or
+any other MongoDB product, please report it according to the instructions found
+in the :manual:`Create a Vulnerability Report
+</tutorial/create-a-vulnerability-report>`.
+
+
+Request Product Features
+========================
+
+To request a feature which is not specific to the Ruby driver, or which
+affects more than the driver alone (for example, a feature which requires
+MongoDB server support), please submit your idea through the
+`MongoDB Feedback Forum <https://feedback.mongodb.com/forums/924286-drivers>`_.
+
+
+Contribute Code
+===============
+
+The MongoDB Ruby driver source is located
+`at GitHub <https://github.com/mongodb/mongo-ruby-driver>`_.
+
+The list of known issues in the driver is available
+`in JIRA <https://jira.mongodb.org/browse/RUBY>`_.
+
+We recommend creating a JIRA ticket before starting work on a bug fix or
+an improvement to the driver, to obtain feedback from the Ruby driver team
+as to the proposed changes. A JIRA ticket is not required to submit
+a pull request but it is appreciated, especially for non-trivial changes.
+
+Pull requests should be made against the ``master`` branch and
+include relevant tests, if applicable. The Ruby driver team will backport
+the changes to the stable branches, if needed.
+
+A MongoDB deployment is required to run the tests. Setup procedures and
+recommendations for various deployments, as well as how to configure the
+driver's test suite for the deployments, are covered in the `spec
+readme <https://github.com/mongodb/mongo-ruby-driver/blob/master/spec/README.md>`__.
+
+The driver is tested on `Evergreen <https://github.com/evergreen-ci/evergreen>`_,
+MongoDB's in-house continuous integration platform. After a pull request
+is created, one of the Ruby driver team engineers will schedule an Evergreen
+build.

source/getting-started.txt

@@ -0,0 +1,17 @@
+.. _getting-started:
+
+***************
+Getting Started
+***************
+
+.. default-domain:: mongodb
+
+This section describes how to install the driver, installation prerequisites
+and compatibility considerations.
+
+.. toctree::
+  :titlesonly:
+
+  installation
+  reference/driver-compatibility
+  support

source/includes/unicode-checkmark.rst

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

source/includes/unicode-nbsp.rst

@@ -0,0 +1,2 @@
+.. |nbsp| unicode:: 0xA0
+  :trim:

source/index.txt

@@ -0,0 +1,67 @@
+.. http://www.mongodb.org/display/DOCS/Ruby+Language+Center
+
+.. _ruby-language-center:
+
+*******************
+Ruby MongoDB Driver
+*******************
+
+.. default-domain:: mongodb
+
+Welcome to the documentation site for the official MongoDB Ruby driver.
+You can add the driver to your application to work with MongoDB in
+Ruby.
+
+Get Started
+===========
+
+To get started with the Ruby driver, see :doc:`/installation` and
+:doc:`/tutorials/quick-start`. Continue to :doc:`/tutorials`
+for high level documentation for common operations.
+
+BSON
+====
+
+The Ruby BSON implementation is packaged in a separate gem with C and
+Java extensions for speed depending on the runtime environment.
+
+For reference on the Ruby BSON gem, see the :doc:`/tutorials/bson`.
+
+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.
+
+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 the `Mongoid Manual <https://mongodb.com/docs/mongoid/master>`_.
+
+.. 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:
+
+    getting-started
+    tutorials
+    reference/connection-and-configuration
+    reference/working-with-data
+    reference/schema-operations
+    API <https://mongodb.com/docs/ruby-driver/current/api/>
+    release-notes
+    reference/additional-resources
+    contribute

source/installation.txt

@@ -0,0 +1,56 @@
+************
+Installation
+************
+
+.. default-domain:: mongodb
+
+The Ruby driver is released as a gem hosted on `Rubygems
+<https://rubygems.org/gems/mongo>`_.
+
+
+Prerequisites
+=============
+
+Please see the :ref:`compatibility <compatibility>` page for the list of
+Ruby versions and MongoDB server versions that this release of the Ruby
+driver is compatible with.
+
+The driver itself is written entirely in Ruby, however it depends on the
+`bson library <https://rubygems.org/gems/bson>`_ which includes a C extension
+for MRI and a compiled Java extension for JRuby. A working C compiler and Ruby
+development headers and libraries are required when installing on MRI.
+When installing on JRuby, JRE is sufficient because the ``bson`` gem includes
+the compiled extension.
+
+Connecting to TLS-enabled MongoDB servers, using SCRAM authentication
+(both SCRAM-SHA-1 and SCRAM-SHA-256) and using X.509 authentication (which
+is performed over a TLS connection) requires the Ruby ``openssl`` extension
+to be present and working. The :ref:`TLS compatibility <tls-compatibility>`
+section provides further details on usage of newer TLS protocols like TLS 1.1.
+
+
+.. _installation:
+
+Install the Gem
+===============
+
+Add ``mongo`` to your ``Gemfile``:
+
+.. code-block:: ruby
+
+  gem "mongo", "~> 2"
+
+To install the driver manually:
+
+.. code-block:: sh
+
+  gem install mongo -v '~> 2'
+
+
+What's New
+==========
+
+Please see the :ref:`release notes <release-notes>` for the major changes
+in each driver release and the `releases page on GitHub
+<https://github.com/mongodb/mongo-ruby-driver/releases>`_ for the complete
+list of changes for each release of the driver.