Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ ruby-driver = "Ruby driver"
language = "Ruby"
quickstart-sinatra-app-name = "my-sinatra-app"
feedback-widget-title = "Feedback"
server-manual = "Server manual"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions source/includes/quick-start/create-cxn-str.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
You can connect to your MongoDB deployment by providing a
**connection URI**, also called a *connection string*, which
instructs {+odm+} on how to connect to a MongoDB deployment
Copy link
Contributor

Choose a reason for hiding this comment

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

S: avoid 'on' to mean 'about'. open to other alternatives than this one

Suggested change
instructs {+odm+} on how to connect to a MongoDB deployment
tells {+odm+} how to connect to a MongoDB deployment

and how to behave while connected.

The connection string includes the hostname or IP address and
port of your deployment, the authentication mechanism, user credentials
when applicable, and connection options.

To learn about connecting to an instance or deployment not hosted on
Atlas, see :manual:`Connection Strings </reference/connection-string/>`
in the {+server-manual+}.

.. procedure::
:style: connected

.. step:: Find your MongoDB Atlas connection string

To retrieve your connection string for the deployment that
you created in the previous step, log in to your Atlas account.
Then, navigate to the :guilabel:`Database` section and click the
:guilabel:`Connect` button for your new deployment.

.. figure:: /includes/figures/atlas_connection_select_cluster.png
:alt: The connect button in the clusters section of the Atlas UI

Proceed to the :guilabel:`Connect your application` section. Select
**{+language+}** from the :guilabel:`Driver` selection menu and
the most recent {+ruby-driver+} version from the
:guilabel:`Version` selection menu.

Deselect the :guilabel:`View full code sample` option to view only
the connection string.

.. step:: Copy your connection string

Click the button on the right of the connection string to copy it
to your clipboard.

.. step:: Update the placeholders

Paste the connection string into a file in your preferred text editor
and replace the ``<username>`` and ``<password>`` placeholders with
your database user's username and password.

Save this file to a safe location for use in the next step.

After completing these steps, you have a connection string that
contains your database username and password.

.. include:: /includes/quick-start/troubleshoot.rst
22 changes: 22 additions & 0 deletions source/includes/quick-start/create-deployment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
You can create a free tier MongoDB deployment on MongoDB Atlas
Copy link
Contributor

Choose a reason for hiding this comment

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

S: compound adjective

Suggested change
You can create a free tier MongoDB deployment on MongoDB Atlas
You can create a free-tier MongoDB deployment on MongoDB Atlas

to store and manage your data. MongoDB Atlas hosts and manages
your MongoDB database in the cloud.

.. procedure::
:style: connected

.. step:: Create a free MongoDB deployment on Atlas

Complete the :atlas:`Get Started with Atlas </getting-started>`
guide to set up a new Atlas account and load sample data into a new free
tier MongoDB deployment.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
guide to set up a new Atlas account and load sample data into a new free
tier MongoDB deployment.
guide to set up a new Atlas account and load sample data into a new free-
tier MongoDB deployment.


.. step:: Save your credentials

After you create your database user, save that user's
username and password to a safe location for use in an upcoming step.

After completing these steps, you have a new free tier MongoDB deployment on
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After completing these steps, you have a new free tier MongoDB deployment on
After completing these steps, you have a new free-tier MongoDB deployment on

Atlas, database user credentials, and sample data loaded into your database.

.. include:: /includes/quick-start/troubleshoot.rst
4 changes: 2 additions & 2 deletions source/quick-start-sinatra.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ that connects to a MongoDB deployment.
.. toctree::

/quick-start-sinatra/download-and-install/
/quick-start-sinatra/create-a-deployment/
/quick-start-sinatra/create-a-connection-string/

.. /quick-start-sinatra/create-a-deployment/
.. /quick-start-sinatra/create-a-connection-string/
.. /quick-start-sinatra/configure-mongodb/
.. /quick-start-sinatra/view-data/
.. /quick-start-sinatra/write-data/
Expand Down
7 changes: 7 additions & 0 deletions source/quick-start-sinatra/create-a-connection-string.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _mongoid-quick-start-sinatra-create-cxn-str:

==========================
Create a Connection String
==========================

.. include:: /includes/quick-start/create-cxn-str.rst
7 changes: 7 additions & 0 deletions source/quick-start-sinatra/create-a-deployment.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _mongoid-quick-start-sinatra-create-deployment:

===========================
Create a MongoDB Deployment
===========================

.. include:: /includes/quick-start/create-deployment.rst
Loading