Skip to content

Commit 3119a64

Browse files
DOCSP-15496 MongoCLI Atlas QuickStart improvements (#499)
* DOCSP-15496 MongoCLI Atlas QuickStart improvements * DOCSP-15496 updates for copy review feedback
1 parent b708f58 commit 3119a64

File tree

9 files changed

+468
-448
lines changed

9 files changed

+468
-448
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title = "MongoDB Command Line Interface"
44
intersphinx = ["https://docs.opsmanager.mongodb.com/current/objects.inv", "https://docs.mongodb.com/manual/objects.inv",
55
"https://docs.atlas.mongodb.com/objects.inv"]
66

7-
toc_landing_pages = ["/configure", "/install"]
7+
toc_landing_pages = ["/configure", "/install", "/quick-start"]
88

99
[constants]
1010
aagent = "Automation Agent"

source/configure/go-template-output.txt

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ Examples
4343
.. tab:: Specify Template With the Command
4444
:tabid: template-command
4545

46-
For example, the following command uses the template to retrieve a
47-
count of the number of projects in the specified organization using the
46+
Retrieve the Number of Projects
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
The following command uses the template to retrieve a count of
50+
the number of projects in the specified organization using the
4851
{+default-profile+}:
4952

5053
.. code-block:: shell
@@ -57,6 +60,41 @@ Examples
5760
:copyable: false
5861

5962
Count: 2
63+
64+
.. _quick-start-atlas-retrieve-conection-string:
65+
66+
Retrieve Your |service| Cluster Connection String
67+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
69+
The following :ref:`mcli-atlas-cluster-describe-command` command
70+
uses the template to retrieve the connection string for an
71+
|service| cluster named ``getStarted``. It uses the default
72+
profile for accessing |service|.
73+
74+
.. code-block:: sh
75+
76+
mongocli atlas clusters describe getStarted -o go-template="Parse: {{.SrvAddress}}"
77+
78+
The previous command returns a string similar to the following:
79+
80+
.. code-block:: sh
81+
:copyable: false
82+
83+
Parse: mongodb+srv://getstarted.example.mongodb.net
84+
85+
You can use the |mongo| shell to connect to the ``getStarted``
86+
cluster with the ``srvAddress`` and the :manual:`connection
87+
string
88+
</reference/connection-string/#connection-string-options>`. This
89+
example uses the following to connect to the |service| cluster:
90+
91+
- The connection string returned by the previous command
92+
- The username and password created in this :ref:`tutorial
93+
<mcli-quick-start-atlas>`
94+
95+
.. code-block::
96+
97+
mongo "mongodb+srv://getstarted.example.mongodb.net" --username User1 --password ChangeThisPasswordToSomethingSecure
6098

6199
.. tab:: Specify Template Using a File
62100
:tabid: template-file
@@ -81,3 +119,4 @@ Examples
81119
:copyable: false
82120

83121
Projects: 5e2211c17a3e5a48f5497de3 5f455b39749bea5fb575dccc
122+
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
Congratulations! You have successfully created a cluster to host your
2-
data. You can view your cluster by logging in to the UI.
3-
2+
data. You can connect to your cluster using the :manual:`connection
3+
string </reference/connection-string/#connection-string-options>` for
4+
the |mongo| shell or your application or view your cluster by logging
5+
in to the UI.

0 commit comments

Comments
 (0)