diff --git a/source/get-started.txt b/source/get-started.txt index 6058a592..93a8ca25 100644 --- a/source/get-started.txt +++ b/source/get-started.txt @@ -21,10 +21,10 @@ Get Started with the Ruby Driver .. toctree:: Download & Install - -.. TODO: Create a Deployment Create a Connection String + +.. TODO: Connect to MongoDB Next Steps diff --git a/source/get-started/create-a-connection-string.txt b/source/get-started/create-a-connection-string.txt new file mode 100644 index 00000000..92d15da9 --- /dev/null +++ b/source/get-started/create-a-connection-string.txt @@ -0,0 +1,58 @@ +.. _ruby-get-started-connection-string: + +========================== +Create a Connection String +========================== + +You can connect to your MongoDB deployment by providing a +**connection URI**, also called a *connection string*, which +instructs the driver 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. + +.. TODO: + To connect to an instance or deployment not hosted on Atlas, see + :ref:`ruby-connection-targets`. + +.. procedure:: + :style: connected + + .. step:: Find your MongoDB Atlas connection string + + To retrieve your connection string for the deployment that + you created in the :ref:`previous step `, + log in to your Atlas account and navigate to the + :guilabel:`Clusters` section. Then, click the :guilabel:`Connect` button + for your new deployment. + + .. figure:: /includes/figures/atlas_connection_connect_cluster.png + :alt: The connect button in the clusters section of the Atlas UI + + Proceed to the :guilabel:`Connect your application` section. Select + "Ruby" from the :guilabel:`Driver` selection menu and the version + that best matches your installed version from the :guilabel:`Version` + selection menu. + + .. step:: Copy your connection string + + Click the copy button on the right of the connection string to copy it to + your clipboard, as shown in the following screenshot: + + .. figure:: /includes/figures/atlas_connection_copy_string_ruby.png + :alt: The connection string copy button in the Atlas UI + + .. step:: Update the placeholders + + Paste this connection string into a file in your preferred text editor + and replace the ```` and ```` 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/get-started/quickstart-troubleshoot.rst \ No newline at end of file diff --git a/source/get-started/create-a-deployment.txt b/source/get-started/create-a-deployment.txt new file mode 100644 index 00000000..21925b7f --- /dev/null +++ b/source/get-started/create-a-deployment.txt @@ -0,0 +1,29 @@ +.. _ruby-get-started-create-deployment: + +=========================== +Create a MongoDB Deployment +=========================== + +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 ` + 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 you complete these steps, you have a new free tier MongoDB +deployment on Atlas, database user credentials, and sample data loaded +in your database. + +.. include:: /includes/get-started/quickstart-troubleshoot.rst \ No newline at end of file diff --git a/source/includes/figures/atlas_connection_connect_cluster.png b/source/includes/figures/atlas_connection_connect_cluster.png new file mode 100644 index 00000000..b8a73731 Binary files /dev/null and b/source/includes/figures/atlas_connection_connect_cluster.png differ diff --git a/source/includes/figures/atlas_connection_copy_string_ruby.png b/source/includes/figures/atlas_connection_copy_string_ruby.png new file mode 100644 index 00000000..849206f6 Binary files /dev/null and b/source/includes/figures/atlas_connection_copy_string_ruby.png differ