diff --git a/source/index.txt b/source/index.txt index 32dfb06b..f94cdfe0 100644 --- a/source/index.txt +++ b/source/index.txt @@ -1,59 +1,119 @@ -.. _ruby-language-center: +==================== +{+driver-long+} +==================== -******************* -Ruby MongoDB Driver -******************* +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: twocols -.. class:: hidden +.. toctree:: + :titlesonly: + :maxdepth: 1 + + View the Source + API Documentation <{+api-root+}> - .. toctree:: - :titlesonly: +.. TODO: + Get Started + Connect + Databases & Collections + Read Data + Write Data + Operations on Replica Sets + Indexes + Monitor Your Application + Data Aggregation + Security + Issues & Help + What's New + Upgrade + Compatibility - Get Started - Connect to MongoDB - Tutorials - Connection & Configuration - Working with Data - Schema Operations - API - Release Notes - Additional Resources - Contribute +Introduction +------------ -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. +Welcome to the documentation site for the {+driver-long+}, the official +MongoDB driver for {+language+} applications. -Get Started -=========== +.. TODO: +.. 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. +.. Learn how to install the driver, establish a connection to MongoDB, and begin +.. working with data in the :ref:`ruby-get-started` tutorial. -BSON -==== +.. Connect to MongoDB +.. ------------------ -The Ruby BSON implementation is packaged in a separate gem with C and -Java extensions for speed depending on the runtime environment. +.. Learn how to create and configure a connection to a MongoDB deployment +.. in the :ref:`ruby-connect` section. -For reference on the Ruby BSON gem, see the :doc:`/tutorials/bson`. +.. Databases and Collections +.. ------------------------- -Object Mappers -============== +.. Learn how to use the {+driver-short+} to work with MongoDB databases and collections in the +.. :ref:`ruby-databases-collections` section. -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. +.. Read Data from MongoDB +.. ---------------------- -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). +.. Learn how you can retrieve data from MongoDB in the :ref:`ruby-read` section. -The ODM officially supported by MongoDB is Mongoid, originally written -by Durran Jordan. +.. Write Data to MongoDB +.. --------------------- -For tutorials on Mongoid, see the `Mongoid Manual `_. \ No newline at end of file +.. Learn how you can write data to MongoDB in the :ref:`ruby-write` section. + +.. Configure Operations on Replica Sets +.. ------------------------------------ + +.. Learn how to configure read and write operations on a replica set in the +.. :ref:`ruby-read-write-pref` section. + +.. Optimize Queries by Using Indexes +.. --------------------------------- + +.. Learn how to work with common types of indexes in the :ref:`ruby-indexes` +.. section. + +.. Transform Your Data with Aggregation +.. ------------------------------------ + +.. Learn how to use the {+driver-short+} to perform aggregation operations in the +.. :ref:`ruby-aggregation` section. + +.. Secure Your Data +.. ---------------- + +.. Learn how to authenticate your application and encrypt your data in the +.. :ref:`ruby-security` section. + +.. What's New +.. ---------- + +.. For a list of new features and changes in each version, see the :ref:`What's New ` +.. section. + +.. Upgrade Driver Versions +.. ----------------------- + +.. Learn what changes you must make to your application to upgrade driver +.. versions in the :ref:`ruby-upgrade` section. + +.. Compatibility +.. ------------- + +.. To learn about the versions of the {+mdb-server+} and the {+language+} language +.. that are compatible with each version of the {+driver-short+}, see the +.. :ref:`Compatibility ` section. + +Developer Hub +------------- + +The Developer Hub provides tutorials and social engagement for +developers. + +To ask questions and engage in discussions with fellow developers who +use the {+driver-short+}, see the `forums page. `__ diff --git a/source/contribute.txt b/source/old-content/contribute.txt similarity index 100% rename from source/contribute.txt rename to source/old-content/contribute.txt diff --git a/source/getting-started.txt b/source/old-content/getting-started.txt similarity index 100% rename from source/getting-started.txt rename to source/old-content/getting-started.txt diff --git a/source/installation.txt b/source/old-content/installation.txt similarity index 100% rename from source/installation.txt rename to source/old-content/installation.txt diff --git a/source/reference/additional-resources.txt b/source/old-content/reference/additional-resources.txt similarity index 100% rename from source/reference/additional-resources.txt rename to source/old-content/reference/additional-resources.txt diff --git a/source/reference/aggregation.txt b/source/old-content/reference/aggregation.txt similarity index 100% rename from source/reference/aggregation.txt rename to source/old-content/reference/aggregation.txt diff --git a/source/reference/authentication.txt b/source/old-content/reference/authentication.txt similarity index 100% rename from source/reference/authentication.txt rename to source/old-content/reference/authentication.txt diff --git a/source/reference/bulk-operations.txt b/source/old-content/reference/bulk-operations.txt similarity index 100% rename from source/reference/bulk-operations.txt rename to source/old-content/reference/bulk-operations.txt diff --git a/source/reference/change-streams.txt b/source/old-content/reference/change-streams.txt similarity index 100% rename from source/reference/change-streams.txt rename to source/old-content/reference/change-streams.txt diff --git a/source/reference/collations.txt b/source/old-content/reference/collations.txt similarity index 100% rename from source/reference/collations.txt rename to source/old-content/reference/collations.txt diff --git a/source/reference/collection-tasks.txt b/source/old-content/reference/collection-tasks.txt similarity index 100% rename from source/reference/collection-tasks.txt rename to source/old-content/reference/collection-tasks.txt diff --git a/source/reference/connection-and-configuration.txt b/source/old-content/reference/connection-and-configuration.txt similarity index 100% rename from source/reference/connection-and-configuration.txt rename to source/old-content/reference/connection-and-configuration.txt diff --git a/source/reference/create-client.txt b/source/old-content/reference/create-client.txt similarity index 100% rename from source/reference/create-client.txt rename to source/old-content/reference/create-client.txt diff --git a/source/reference/crud-operations.txt b/source/old-content/reference/crud-operations.txt similarity index 99% rename from source/reference/crud-operations.txt rename to source/old-content/reference/crud-operations.txt index 86e11ddb..15fc3739 100644 --- a/source/reference/crud-operations.txt +++ b/source/old-content/reference/crud-operations.txt @@ -93,7 +93,7 @@ Specify a ``Decimal128`` number .. versionadded:: 3.4 :manual:`Decimal128` is a -:doc:`BSON datatype ` +:ref:`BSON datatype ` that employs 128-bit decimal-based floating-point values capable of emulating decimal rounding with exact precision. This functionality is intended for applications that handle diff --git a/source/reference/database-tasks.txt b/source/old-content/reference/database-tasks.txt similarity index 100% rename from source/reference/database-tasks.txt rename to source/old-content/reference/database-tasks.txt diff --git a/source/reference/driver-compatibility.txt b/source/old-content/reference/driver-compatibility.txt similarity index 100% rename from source/reference/driver-compatibility.txt rename to source/old-content/reference/driver-compatibility.txt diff --git a/source/reference/geospatial-search.txt b/source/old-content/reference/geospatial-search.txt similarity index 100% rename from source/reference/geospatial-search.txt rename to source/old-content/reference/geospatial-search.txt diff --git a/source/reference/gridfs.txt b/source/old-content/reference/gridfs.txt similarity index 100% rename from source/reference/gridfs.txt rename to source/old-content/reference/gridfs.txt diff --git a/source/reference/in-use-encryption.txt b/source/old-content/reference/in-use-encryption.txt similarity index 100% rename from source/reference/in-use-encryption.txt rename to source/old-content/reference/in-use-encryption.txt diff --git a/source/reference/in-use-encryption/client-side-encryption.txt b/source/old-content/reference/in-use-encryption/client-side-encryption.txt similarity index 100% rename from source/reference/in-use-encryption/client-side-encryption.txt rename to source/old-content/reference/in-use-encryption/client-side-encryption.txt diff --git a/source/reference/in-use-encryption/queryable-encryption.txt b/source/old-content/reference/in-use-encryption/queryable-encryption.txt similarity index 100% rename from source/reference/in-use-encryption/queryable-encryption.txt rename to source/old-content/reference/in-use-encryption/queryable-encryption.txt diff --git a/source/reference/indexing.txt b/source/old-content/reference/indexing.txt similarity index 100% rename from source/reference/indexing.txt rename to source/old-content/reference/indexing.txt diff --git a/source/reference/map-reduce.txt b/source/old-content/reference/map-reduce.txt similarity index 100% rename from source/reference/map-reduce.txt rename to source/old-content/reference/map-reduce.txt diff --git a/source/reference/monitoring.txt b/source/old-content/reference/monitoring.txt similarity index 100% rename from source/reference/monitoring.txt rename to source/old-content/reference/monitoring.txt diff --git a/source/reference/projection.txt b/source/old-content/reference/projection.txt similarity index 100% rename from source/reference/projection.txt rename to source/old-content/reference/projection.txt diff --git a/source/reference/query-cache.txt b/source/old-content/reference/query-cache.txt similarity index 100% rename from source/reference/query-cache.txt rename to source/old-content/reference/query-cache.txt diff --git a/source/reference/schema-operations.txt b/source/old-content/reference/schema-operations.txt similarity index 100% rename from source/reference/schema-operations.txt rename to source/old-content/reference/schema-operations.txt diff --git a/source/reference/search-indexes.txt b/source/old-content/reference/search-indexes.txt similarity index 100% rename from source/reference/search-indexes.txt rename to source/old-content/reference/search-indexes.txt diff --git a/source/reference/sessions.txt b/source/old-content/reference/sessions.txt similarity index 100% rename from source/reference/sessions.txt rename to source/old-content/reference/sessions.txt diff --git a/source/reference/text-search.txt b/source/old-content/reference/text-search.txt similarity index 100% rename from source/reference/text-search.txt rename to source/old-content/reference/text-search.txt diff --git a/source/reference/transactions.txt b/source/old-content/reference/transactions.txt similarity index 100% rename from source/reference/transactions.txt rename to source/old-content/reference/transactions.txt diff --git a/source/reference/user-management.txt b/source/old-content/reference/user-management.txt similarity index 100% rename from source/reference/user-management.txt rename to source/old-content/reference/user-management.txt diff --git a/source/reference/working-with-data.txt b/source/old-content/reference/working-with-data.txt similarity index 100% rename from source/reference/working-with-data.txt rename to source/old-content/reference/working-with-data.txt diff --git a/source/release-notes.txt b/source/old-content/release-notes.txt similarity index 100% rename from source/release-notes.txt rename to source/old-content/release-notes.txt diff --git a/source/support.txt b/source/old-content/support.txt similarity index 100% rename from source/support.txt rename to source/old-content/support.txt diff --git a/source/tutorials.txt b/source/old-content/tutorials.txt similarity index 100% rename from source/tutorials.txt rename to source/old-content/tutorials.txt diff --git a/source/tutorials/bson.txt b/source/old-content/tutorials/bson.txt similarity index 100% rename from source/tutorials/bson.txt rename to source/old-content/tutorials/bson.txt diff --git a/source/tutorials/common-errors.txt b/source/old-content/tutorials/common-errors.txt similarity index 100% rename from source/tutorials/common-errors.txt rename to source/old-content/tutorials/common-errors.txt diff --git a/source/tutorials/quick-start.txt b/source/old-content/tutorials/quick-start.txt similarity index 100% rename from source/tutorials/quick-start.txt rename to source/old-content/tutorials/quick-start.txt