Skip to content

DOCSP-45170: Landing page and cleanup #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 104 additions & 44 deletions source/index.txt
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/mongodb/mongo-ruby-driver>
API Documentation <{+api-root+}>

.. toctree::
:titlesonly:
.. TODO:
Get Started </get-started>
Connect </connect>
Databases & Collections </databases-collections>
Read Data </read>
Write Data </write>
Operations on Replica Sets </read-write-pref>
Indexes </indexes>
Monitor Your Application </monitoring>
Data Aggregation </aggregation>
Security </security>
Issues & Help </issues-and-help>
What's New </whats-new>
Upgrade </upgrade>
Compatibility </compatibility>

Get Started <getting-started>
Connect to MongoDB <connect>
Tutorials <tutorials>
Connection & Configuration <reference/connection-and-configuration>
Working with Data <reference/working-with-data>
Schema Operations <reference/schema-operations>
API <https://mongodb.com/docs/ruby-driver/current/api/>
Release Notes <release-notes>
Additional Resources <reference/additional-resources>
Contribute <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 <https://mongodb.com/docs/mongoid/master>`_.
.. 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 <ruby-whats-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 <ruby-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. <https://www.mongodb.com/community/forums/tag/ruby>`__
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Specify a ``Decimal128`` number
.. versionadded:: 3.4

:manual:`Decimal128</tutorial/model-monetary-data>` is a
:doc:`BSON datatype </tutorials/bson>`
:ref:`BSON datatype <ruby-bson-tutorial>`
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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading