Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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
2 changes: 0 additions & 2 deletions .dockerignore

This file was deleted.

13 changes: 0 additions & 13 deletions .github/workflows/check-autobuilder.yml

This file was deleted.

10 changes: 9 additions & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
name = "mongoid"
title = "Mongoid"

intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
"https://www.mongodb.com/docs/atlas/objects.inv"
]

toc_landing_pages = [
"/quick-start"
]

[constants]
rails-6-version = 6.0
rails-7-version = 7.1
odm = "Mongoid"
ruby-driver = "Ruby driver"
18 changes: 9 additions & 9 deletions source/index.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. _mongoid:
.. _mongoid-odm:

*******
Mongoid
*******
=======
{+odm+}
=======

.. default-domain:: mongodb

Mongoid is the officially supported object-document mapper (ODM) for MongoDB in
Ruby. To work with Mongoid from the command line using ``rails``-like tooling,
the `railsmdb <https://github.com/mongodb/mongoid-railsmdb>`_ utility can be used.
{+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, the `railsmdb
<https://github.com/mongodb/mongoid-railsmdb>`_ utility can be used.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: change to active voice

Suggested change
``rails``-like tooling, the `railsmdb
<https://github.com/mongodb/mongoid-railsmdb>`_ utility can be used.
``rails``-like tooling, you can use the `railsmdb
<https://github.com/mongodb/mongoid-railsmdb>`_.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, just left this as placeholder content until the index ticket


.. toctree::
:titlesonly:

/quick-start
installation-configuration
tutorials
schema-configuration
Expand Down
57 changes: 57 additions & 0 deletions source/quick-start.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _mongoid-quick-start:

===========
Quick Start
===========

.. facet::
:name: genre
:values: tutorial

.. meta::
:keywords: php framework, odm

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Overview
--------

This guide shows you how to use {+odm+} in a new web application,
connect to a MongoDB cluster hosted on MongoDB Atlas, and perform
read and write operations on the data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: since "the data" is a little vague:

Suggested change
read and write operations on the data.
read and write operations on the data in your cluster.


.. tip::

If you prefer to connect to MongoDB by using the {+ruby-driver+} without
{+odm+}, see the {+ruby-driver+} :ruby:`Quick Start guide
</tutorials/quick-start/>`.

{+odm+} is an Object-Document Mapper (ODM) framework for MongoDB in
Ruby.

MongoDB Atlas is a fully managed cloud database service that hosts your
MongoDB deployments. You can create your own free (no credit card
required) MongoDB Atlas deployment by following the steps in this guide.

Follow the steps in this guide to create a sample {+odm+} web application
that connects to a MongoDB deployment.

.. TODO .. tip::
..
.. You can download the complete web application project by cloning the
.. `mongoid-quickstart <>`__ GitHub repository.

.. toctree::

/quick-start/download-and-install/

.. /quick-start/create-a-deployment/
.. /quick-start/create-a-connection-string/
.. /quick-start/configure-mongodb/
.. /quick-start/view-data/
.. /quick-start/write-data/
.. /quick-start/next-steps/
Loading