Skip to content
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
4 changes: 1 addition & 3 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
toc_landing_pages = [
"/quick-start-rails",
"/quick-start-sinatra",
"/interact-data",
"/interact-data/specify-query",
"/data-modeling",
"/configuration",
"/issues-and-help"
]

Expand All @@ -35,3 +32,4 @@ api = "https://www.mongodb.com/docs/mongoid/current/api"
ruby-api = "https://www.mongodb.com/docs/ruby-driver/current/api"
active-record-docs = "https://guides.rubyonrails.org"
shared-library = "Automatic Encryption Shared Library"
mdb-server = "MongoDB Server"
83 changes: 75 additions & 8 deletions source/index.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
.. _mongoid-odm-landing:
.. _mongoid-odm:

=======
{+odm+}
=======

{+odm+} is the officially supported object-document mapper (ODM) for
MongoDB in Ruby. To work with {+odm+} from the command line using
``rails``-like tooling, you can use the `railsmdb
<https://github.com/mongodb/mongoid-railsmdb>`_ utility.

.. toctree::
:titlesonly:

Expand All @@ -20,8 +16,79 @@ MongoDB in Ruby. To work with {+odm+} from the command line using
Secure Your Data </security>
Integrations & Tools </integrations-tools>
API Documentation </api>
What's New </whats-new>
Compatibility </compatibility>
What's New </whats-new>
Issues & Help </issues-and-help>
/additional-resources
/ecosystem
View the Source <https://github.com/mongodb/mongoid>

Introduction
------------

Welcome to the documentation site for {+odm+}. {+odm+} is the officially
supported object-document mapper (ODM) for MongoDB in {+language+}. By
using {+odm+}, you can easily interact with your data and create
flexible data models native to {+language+} applications.

You can add {+odm+} to your {+language+} application to connect it to
a MongoDB database. Install {+odm+} by adding it to your project's
``Gemfile`` or set up a runnable project by following one of the
Quick Start guides.

Quick Start
-----------

Learn how to establish a connection to MongoDB Atlas and begin
working with data by following one of the following guides:

- :ref:`mongoid-quick-start-rails`
- :ref:`mongoid-quick-start-sinatra`

Configuration
-------------

To learn how to configure different options in your {+odm+} application,
see the :ref:`mongoid-configuration` section.

Interact with Data
------------------

To learn how to use {+odm+} to interact with your MongoDB data,
see the :ref:`mongoid-interact-data` section.

Model Your Data
---------------

To learn how to model your MongoDB data as {+odm+} models,
see the :ref:`mongoid-data-modeling` section.

Secure Your Data
----------------

To learn how to secure your data by using encryption,
see the :ref:`mongoid-security` section.

Integrations & Tools
--------------------

To learn how to add {+odm+} to an existing application,
see the :ref:`mongoid-integrations-tools` section. This section also
includes information about the {+ror+} framework and other resources.

Compatibility
-------------

To learn about the versions of the {+mdb-server+}, the {+language+}
language, the {+ruby-driver+}, and {+ror+} framework that are compatible
with each version of {+odm+}, see :ref:`mongoid-compatibility`.

What's New
----------

To view a list of new features and changes in each version, see the
:ref:`mongoid-whats-new` section.

Issues & Help
-------------

To find resources for troubleshooting and to learn about contributing to
{+odm+}, see :ref:`mongoid-issues-and-help`.
4 changes: 4 additions & 0 deletions source/integrations-tools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ Integrations & Tools
Add {+odm+} to an Existing Application </integrations-tools/add-existing>
Rails Integration </integrations-tools/rails-integration>
External Resources </integrations-tools/external-resources>

- :ref:`mongoid-add-to-existing`
- :ref:`mongoid-rails-integration`
- :ref:`mongoid-external-resources`
4 changes: 4 additions & 0 deletions source/interact-data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Interact with Data
Perform Data Operations </interact-data/crud>
Specify a Query </interact-data/specify-query>
Modify Query Results </interact-data/modify-results>
Aggregation </interact-data/aggregation>
Search Text </interact-data/text-search>
Transactions and Sessions </interact-data/transaction>
Nested Attributes </interact-data/nested-attributes>
Expand All @@ -33,6 +34,9 @@ MongoDB data.
- :ref:`mongoid-data-modify-results`: Learn how to modify the way that
{+odm+} returns results from queries.

- :ref:`mongoid-aggregation`: Learn how to transform your data by using
MongoDB aggregation.

- :ref:`mongoid-data-text-search`: Learn how to perform efficient
searches on text fields.

Expand Down
File renamed without changes.
107 changes: 0 additions & 107 deletions source/legacy-files/collection-configuration.txt

This file was deleted.

3 changes: 2 additions & 1 deletion source/security.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ Secure Your Data

In this section, you can learn how to secure your data when using {+odm+}.

- :ref:`Client-Side Field Level Encryption <mongoid-encryption>` Learn how to encrypt your data with {+odm+}.
- :ref:`Client-Side Field Level Encryption <mongoid-encryption>` Learn
how to encrypt your data with {+odm+}.
Loading