Skip to content

Commit 7020d7f

Browse files
kyuan-mongodbterakilobyte
authored andcommitted
DOCSP-20812 cleanup (#193)
* cleanup tasks
1 parent 0f5a400 commit 7020d7f

File tree

241 files changed

+217
-23595
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

241 files changed

+217
-23595
lines changed

source/atlas/cluster.txt

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,35 +36,32 @@ Procedure
3636
.. procedure::
3737
:style: normal
3838

39-
.. step:: Navigate to the Database Deployments page for your project.
39+
.. step:: Navigate to the {+db-deployments+} page for your project.
4040

41-
.. procedure::
42-
:style: connected
41+
.. step:: Open the Build a Database dialog.
4342

44-
.. step:: If it is not already displayed, select the
45-
organization that contains your desired project from the
46-
:guilabel:`Organizations` menu in the navigation bar.
43+
Click the :guilabel:`Build a Database` button to display the
44+
:guilabel:`Deploy a cloud database` dialog.
4745

48-
.. step:: If it is not already displayed, select your desired
49-
project from the :guilabel:`Projects` menu in the
50-
navigation bar.
51-
52-
.. step:: If the :guilabel:`Database Deployments` page is not
53-
already displayed, click :guilabel:`Databases` in the
54-
sidebar.
55-
56-
.. step:: Open the Create New Cluster dialog.
57-
58-
Click the :guilabel:`Create` button to display the
59-
:guilabel:`Create New Cluster` dialog.
46+
.. figure:: /images/cluster-db-deployment.png
47+
:figwidth: 600px
48+
:alt: cluster-db-deployment
6049

6150
.. step:: Select a Cluster Type.
6251

6352
Select the :guilabel:`Shared` cluster.
6453

54+
.. figure:: /images/cluster-shared-type.png
55+
:figwidth: 250px
56+
:alt: cluster-shared-type
57+
6558
.. step:: Select a Cluster Tier.
6659

67-
If it is not already selected, select ``M0 Sandbox``.
60+
If it is not already selected, select :guilabel:`M0 Sandbox`.
61+
62+
.. figure:: /images/cluster-m0-tier.png
63+
:figwidth: 600px
64+
:alt: cluster-m0-tier
6865

6966
.. step:: Create the cluster.
7067

@@ -76,7 +73,8 @@ Summary
7673
-------
7774

7875
If you successfully completed the procedure in this guide, you have
79-
created free cluster. In the next guide, you will load our sample data
80-
into your cluster.
76+
created a free cluster.
77+
78+
In the next guide, you will add a database user.
8179

8280
.. guide-next::

source/atlas/connection-string.txt

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,34 @@ What You'll Need
4545
Procedure
4646
---------
4747

48-
.. tabs-selector:: drivers
49-
5048
.. procedure::
5149
:style: normal
5250

5351
.. step:: Navigate to the {+db-deployments+} page for your project.
5452

55-
.. step:: Click the Connect button.
53+
.. step:: Click the :guilabel:`Connect` button.
5654

5755
Click the :guilabel:`Connect` button on the cluster management panel.
5856
The following Atlas screenshot shows the :guilabel:`Connect` button:
5957

60-
.. figure:: /images/connect_panel.png
61-
:figwidth: 328px
62-
:alt: connect-panel
58+
.. figure:: /images/sample-data-cluster.png
59+
:figwidth: 600px
60+
:alt: sample-data-cluster
6361

6462
.. step:: Copy the connection string
6563

66-
.. include:: /includes/driver_copy_paste.rst
64+
In the :guilabel:`Choose your connection method` step in the
65+
modal, select the button marked :guilabel:`Connect Your
66+
Application`.
67+
68+
The following Atlas screenshot shows the connection option
69+
buttons:
70+
71+
.. figure:: /images/connection-string.png
72+
:figwidth: 600px
73+
:alt: connection-string
74+
75+
Follow the instructions for your driver language and version.
6776

6877
Summary
6978
-------

source/atlas/db-user.txt

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ Overview
2222
Add a database user to access the database deployments in your
2323
project.
2424

25-
In this guide, you will add a database user.
25+
After creating your cluster, Atlas directs you to a page called
26+
:guilabel:`Security Quickstart`.
27+
28+
In this guide, you will add a database user in the first section of the
29+
page.
2630

2731
.. time:: 5
2832

@@ -38,28 +42,19 @@ Procedure
3842
.. procedure::
3943
:style: normal
4044

41-
.. step:: Navigate to the {+db-deployments+} page for your project.
42-
43-
.. step:: Open the Add New Database User dialog.
44-
45-
.. procedure::
46-
:style: connected
47-
48-
.. step:: In the :guilabel:`Security` section of the left
49-
navigation, click :guilabel:`Database Access`. The
50-
:guilabel:`Database Users` tab displays.
51-
52-
.. step:: Click :icon-fa5:`plus` :guilabel:`Add New Database User`.
45+
.. step:: Select :guilabel:`Username and Password`.
5346

54-
.. step:: Select Password.
47+
In the :guilabel:`How would you like to authenticate your
48+
connection?` section, select the box labeled :guilabel:`Username
49+
and Password`.
5550

56-
In the :guilabel:`Authentication Method` section of the
57-
:guilabel:`Add New Database User` modal window, select the box
58-
labeled :guilabel:`Password`.
51+
.. figure:: /images/db-user-auth-mech.png
52+
:figwidth: 450px
53+
:alt: db-user-auth-mech
5954

6055
.. step:: Enter the users information.
6156

62-
Under :guilabel:`Password Authentication`, there are two text fields.
57+
In the box underneath, there are two text fields.
6358

6459
.. procedure::
6560
:style: connected
@@ -68,25 +63,29 @@ Procedure
6863

6964
.. step:: Enter a password for the new user in the lower text field.
7065

71-
To use a password auto-generated by Atlas,
72-
click the :guilabel:`Autogenerate Secure Password` button.
66+
Enter a password of your choice, or use an Atlas auto-generated
67+
one, by clicking the :guilabel:`Autogenerate Secure
68+
Password` button.
7369

74-
.. step:: Assign the user a privilege.
70+
.. figure:: /images/db-user-password.png
71+
:figwidth: 600px
72+
:alt: db-user-password
7573

76-
In the :guilabel:`Built-in Role` section, select
77-
:guilabel:`Read and write to any database`.
74+
.. step:: Click :guilabel:`Create User`.
7875

79-
.. step:: Add the user.
76+
Now, you see your user under the :guilabel:`Create User` button.
8077

81-
Click :guilabel:`Add User`. This creates user that can read and
82-
write to any of your database deployments.
78+
.. figure:: /images/db-user-added.png
79+
:figwidth: 600px
80+
:alt: db-user-added
8381

8482
Summary
8583
-------
8684

8785
If you successfully completed the procedure in this guide, you have
8886
added a database user.
8987

90-
In the next guide, you will configure a network connection.
88+
In the next guide, you will continue with the :guilabel:`Security
89+
Quickstart` page to configure a network connection.
9190

9291
.. guide-next::

source/atlas/network-connections.txt

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ Overview
2222
Configure a network connection to allow your users to access the
2323
database deployments in your project.
2424

25-
In this guide, you will configure a network connection.
25+
After creating your cluster, Atlas directs you to a page called
26+
:guilabel:`Security Quickstart`. In the previous guide, we completed the
27+
first section, which added a user to the database.
28+
29+
In this guide, you will configure a network connection with the
30+
last section of the page.
2631

2732
.. time:: 5
2833

@@ -38,33 +43,48 @@ Procedure
3843
.. procedure::
3944
:style: normal
4045

41-
.. step:: Navigate to the {+db-deployments+} page for your project.
42-
43-
.. step:: Go to IP Access List view.
46+
.. step:: Select :guilabel:`My Local Environment`.
47+
48+
In the :guilabel:`Where would you like to connect from?` section,
49+
select the box labeled :guilabel:`My Local Environment`.
50+
51+
.. figure:: /images/network-env.png
52+
:figwidth: 600px
53+
:alt: network-env
54+
55+
.. step:: Add your IP address
56+
57+
In the box labeled :guilabel:`Add entries to your IP Access List`,
58+
click :guilabel:`Add My Current IP Address`.
4459

45-
.. procedure::
46-
:style: connected
60+
.. figure:: /images/network-ip.png
61+
:figwidth: 600px
62+
:alt: network-ip
63+
64+
Now, you see your IP address at the bottom of the box.
4765

48-
.. step:: In the :guilabel:`Security` section of the left
49-
navigation, click :guilabel:`Network Access`. The
50-
:guilabel:`IP Access List` tab displays.
66+
.. figure:: /images/network-added.png
67+
:figwidth: 600px
68+
:alt: network-added
5169

52-
.. step:: Click :icon-fa5:`plus` :guilabel:`Add IP Address`.
70+
.. step:: Click :guilabel:`Finish and Close`.
5371

54-
.. step:: Click Allow Access from Anywhere.
72+
After clicking the :guilabel:`Finish and Create` button at the
73+
bottom of the page, you see the following modal:
5574

56-
.. step:: Add the IP address.
75+
.. figure:: /images/network-complete.png
76+
:figwidth: 450px
77+
:alt: network-complete
78+
5779

58-
Click :guilabel:`Confirm`. This allows your user to access the
59-
database deployments in your project on any network.
6080

6181
Summary
6282
-------
6383

6484
If you successfully completed the procedure in this guide, you have
65-
configured a network connection.
85+
configured a network connection and finished the :guilabel:`Security
86+
Quickstart`.
6687

67-
In the next guide, you will retrieve your database deployments
68-
connection string.
88+
In the next guide, you will load our sample data into your cluster.
6989

7090
.. guide-next::

source/atlas/sample-data.txt

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,35 +42,52 @@ Procedure
4242

4343
.. step:: Click on your cluster name.
4444

45-
.. step:: Click the Collections tab.
45+
.. figure:: /images/sample-data-cluster.png
46+
:figwidth: 600px
47+
:alt: sample-data-cluster
48+
49+
.. step:: Click the :guilabel:`Collections` tab.
50+
51+
.. figure:: /images/sample-data-tab.png
52+
:figwidth: 600px
53+
:alt: sample-data-tab
4654

47-
.. step:: Click Load Sample Dataset.
55+
.. step:: Click :guilabel:`Load Sample Dataset`.
56+
57+
.. figure:: /images/sample-data-load.png
58+
:figwidth: 600px
59+
:alt: sample-data-load
4860

49-
.. step:: In the ensuing dialog, click Load Sample Dataset confirm.
61+
.. step:: In the ensuing dialog, click :guilabel:`Load Sample Dataset` confirm.
62+
63+
.. figure:: /images/sample-data-confirm-load.png
64+
:figwidth: 450px
65+
:alt: sample-data-confirm-load
5066

5167
Once the load completes, the :guilabel:`Collections` tab refreshes
5268
to show your sample data.
5369

54-
You should see the following databases in your cluster:
70+
You see the following databases in your cluster:
5571

5672
.. list-table::
5773
:header-rows: 1
5874
:widths: 20 30
5975

60-
* - Database Name
76+
* - Dataset Name
6177
- Description
6278

6379
* - ``sample-airbnb``
64-
- Contains details on `AirBnB <https://www.airbnb.com>`__
65-
listings.
80+
- Contains details on `AirBnB <https://www.airbnb.com>`__ listings.
6681

6782
* - ``sample-analytics``
68-
- Contains training data for a mock financial services
69-
application.
83+
- Contains training data for a mock financial services application.
7084

7185
* - ``sample-geospatial``
7286
- Contains shipwreck data.
7387

88+
* - ``sample-guides``
89+
- Contains planet data.
90+
7491
* - ``sample-mflix``
7592
- Contains movie data.
7693

@@ -92,6 +109,7 @@ Summary
92109
If you successfully completed the procedure in this guide, you have
93110
loaded our sample data.
94111

95-
In the next guide, you will add a database user.
112+
In the next guide, you will retrieve your database deployments
113+
connection string.
96114

97115
.. guide-next::

source/chapters/aggregation.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)