Skip to content

Commit 88b308f

Browse files
authored
Merge pull request #2 from sarahsimpers/DOCSP-20999
(DOCSP-20999) Adds submodule and symbolic link to Atlas CLI docs, TOC cleanup
2 parents b014c68 + 807126e commit 88b308f

File tree

11 files changed

+24
-11
lines changed

11 files changed

+24
-11
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
.DS_Store
2+
.vscode/settings.json
3+
settings.json

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "submodules/mongodb-atlas-cli"]
2+
path = submodules/mongodb-atlas-cli
3+
url = https://github.com/mongodb/mongodb-atlas-cli.git

.vscode/settings.json

Whitespace-only changes.

snooty.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv",
88
]
99

1010
toc_landing_pages = [
11+
"/atlas-cli-changelog",
12+
"/atlas-cli-env-variables",
1113
"/atlas-cli-profiles",
14+
"/atlas-cli-quickstart",
15+
"/command/atlas",
1216
"/connect-atlas-cli",
1317
"/install-atlas-cli",
14-
"/migrate-to-atlas-cli",
18+
"/migrate-to-atlas-cli"
1519
]
1620

1721
[constants]

source/atlas-cli-changelog.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ including managing:
4545
- Alerts
4646
- Metrics and monitoring
4747

48-
For a complete list of available commands, see :doc:`</atlas-cli-commands>`.
48+
For a complete list of available commands, see :doc:`</command/atlas>`.
4949

5050
To install this version, see :ref:`<install-atlas-cli>`.

source/command

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../submodules/mongodb-atlas-cli/docs/atlascli/command

source/connect-atlas-cli.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ from the {+atlas-cli+}.
162162

163163
.. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags.
164164

165-
When you run :doc:`{+atlas-cli+} commands <atlas-cli-commands>` for
165+
When you run :doc:`{+atlas-cli+} commands </command/atlas>` for
166166
the duration of your {+atlas-cli+} session, specify your Project ID and Org ID
167167
using the ``--projectId`` and ``--orgId`` flags.
168168

@@ -195,7 +195,7 @@ from the {+atlas-cli+}.
195195

196196
.. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags.
197197

198-
When you run :doc:`{+atlas-cli+} commands <atlas-cli-commands>` for
198+
When you run :doc:`{+atlas-cli+} commands </command/atlas>` for
199199
the duration of your {+atlas-cli+} session, specify your Project ID and Org ID
200200
using the ``--projectId`` and ``--orgId`` flags.
201201

@@ -211,7 +211,7 @@ Take the Next Steps
211211
-------------------
212212

213213
Start using the
214-
:doc:`{+atlas-cli+} commands <atlas-cli-commands>`.
214+
:doc:`{+atlas-cli+} commands </command/atlas>`.
215215

216216
To save connection settings by modifying the default profile or create a
217217
different profile, see :ref:`<atlas-cli-profiles>`.
@@ -220,6 +220,7 @@ different profile, see :ref:`<atlas-cli-profiles>`.
220220
.. toctree::
221221

222222
/atlas-cli-save-connection-settings
223+
/atlas-cli-env-variables
223224
/migrate-to-atlas-cli
224225

225226

source/index.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@ Follow these steps to get started using the {+atlas-cli+}:
2727

2828
1. :ref:`Install the {+atlas-cli+} <install-atlas-cli>`
2929
2. :ref:`Connect from the {+atlas-cli+} <connect-atlas-cli>`
30-
3. :doc:`Learn the {+atlas-cli+} commands <atlas-cli-commands>`
30+
3. :doc:`Learn the {+atlas-cli+} commands </command/atlas>`
3131

3232
.. toctree::
3333
:titlesonly:
3434

3535
Overview </index>
3636
/install-atlas-cli
3737
/connect-atlas-cli
38-
/atlas-cli-commands
38+
/atlas-cli-quickstart
39+
Atlas CLI Commands </command/atlas>
3940
/atlas-cli-changelog

source/install-atlas-cli.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,6 @@ Take the Next Steps
448448
-------------------
449449

450450
:ref:`<connect-atlas-cli>` to start using the
451-
:doc:`{+atlas-cli+} commands <atlas-cli-commands>`.
451+
:doc:`{+atlas-cli+} commands </command/atlas>`.
452452

453453

source/migrate-to-atlas-cli.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ following steps to migrate from the {+mcli+} to the {+atlas-cli+}:
3535
If you use any automation scripts that rely on ``mongocli.toml`` or
3636
use {+mcli+} |service| commands, update the scripts to point to the
3737
:ref:`new configuration file <config-toml-location>` and use
38-
:doc:`{+atlas-cli+} commands <atlas-cli-commands>` instead.
38+
:doc:`{+atlas-cli+} commands </command/atlas>` instead.
3939

4040
.. note::
4141

@@ -54,9 +54,9 @@ following steps to migrate from the {+mcli+} to the {+atlas-cli+}:
5454
You can authenticate using either ``atlas auth login`` or ``atlas
5555
config init``. To learn more, see :ref:`<connect-atlas-cli>`.
5656

57-
.. step:: Use the new :doc:`{+atlas-cli+} commands <atlas-cli-commands>`.
57+
.. step:: Use the new :doc:`{+atlas-cli+} commands </command/atlas>`.
5858

59-
Use :doc:`{+atlas-cli+} commands <atlas-cli-commands>` (starting
59+
Use :doc:`{+atlas-cli+} commands </command/atlas>` (starting
6060
with ``atlas``) wherever you previously used {+mcli+} |service|
6161
commands (starting with ``mongocli atlas``). You can use profiles
6262
that {+atlas-cli+} migrates

submodules/mongodb-atlas-cli

Submodule mongodb-atlas-cli added at d7a3ade

0 commit comments

Comments
 (0)