Skip to content

Commit b48c40d

Browse files
Revert "DOCSP-11191 doc for onlinearchive pause command" (#158)
1 parent 47e05d7 commit b48c40d

File tree

6 files changed

+28
-161
lines changed

6 files changed

+28
-161
lines changed

source/reference/atlas.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Atlas ``mongocli`` Commands
5454
Events </reference/atlas/event-commands>
5555
Logs </reference/atlas/log-commands>
5656
Metrics </reference/atlas/metric-commands>
57+
Online Archives </reference/atlas/onlinearchive-commands>
5758
Processes </reference/atlas/process-commands>
5859
Whitelists </reference/atlas/whitelist-commands>
5960
Data Lakes </reference/atlas/datalake-commands>

source/reference/atlas/cluster-commands.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,4 @@ Atlas ``cluster`` Commands
1717
Pause a Cluster </reference/atlas/cluster-pause>
1818
Resume a Cluster </reference/atlas/cluster-start>
1919
Watch a Cluster </reference/atlas/cluster-watch>
20-
Online Archives </reference/atlas/onlinearchive-commands>
2120
Create a Rolling Index </reference/atlas/clusters-indexes-create>

source/reference/atlas/onlinearchive-commands.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@ Atlas Online Archive Commands
1616
Create an Online Archive </reference/atlas/onlinearchive-create>
1717
Modify an Online Archive </reference/atlas/onlinearchive-update>
1818
Start an Online Archive </reference/atlas/onlinearchive-start>
19-
Pause an Active Online Archive </reference/atlas/onlinearchive-pause>
2019

source/reference/atlas/onlinearchive-create.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-cluster-onlinearchive-create-command:
1+
.. _mcli-atlas-onlinearchive-create-command:
22

3-
===========================================
4-
mongocli atlas cluster onlinearchive create
5-
===========================================
3+
===================================
4+
mongocli atlas onlinearchive create
5+
===================================
66

77
.. default-domain:: mongodb
88

@@ -18,14 +18,14 @@ The ``onlinearchive create`` command creates an :atlas:`online archive
1818
</online-archive/manage-online-archive/>` for the specified collection in the ``M10`` or higher cluster. You can also create an online archive through the
1919
|service| :atlas:`UI </online-archive/configure-online-archive/>` or :atlas:`API </reference/api/online-archive-create-one/>`.
2020

21-
.. _mcli-atlas-cluster-online-archive-create-syntax:
21+
.. _mcli-atlas-online-archive-create-syntax:
2222

2323
Syntax
2424
------
2525

2626
.. code-block:: text
2727

28-
mongocli atlas cluster onlinearchive create
28+
mongocli atlas onlinearchive create
2929
--archiveAfter <number-of-days>
3030
--clusterName <cluster-name>
3131
--collection <collection-name>
@@ -35,7 +35,7 @@ Syntax
3535
[ --profile|-P <profile-name> ]
3636
[ --projectId <project-ID> ]
3737

38-
.. _mcli-atlas-cluster-onlinearchive-create-options:
38+
.. _mcli-atlas-onlinearchive-create-options:
3939

4040
Options
4141
-------
@@ -49,27 +49,27 @@ Options
4949
- Description
5050
- Required?
5151

52-
* - ``--archiveAfter``
52+
* - ``archiveAfter``
5353
- int
5454
- Number of days after which to archive cluster data.
5555
- yes
5656

57-
* - ``--clusterName``
57+
* - ``clusterName``
5858
- string
5959
- Name of the cluster.
6060
- yes
6161

62-
* - ``--collection``
62+
* - ``collection``
6363
- string
6464
- Name of the collection for which to create an online archive.
6565
- yes
6666

67-
* - ``--dateField``
67+
* - ``dateField``
6868
- string
6969
- Name of an already indexed date field from the documents.
7070
- yes
7171

72-
* - ``--db``
72+
* - ``db``
7373
- string
7474
- Name of the database that contains the collection.
7575
- yes
@@ -100,7 +100,7 @@ Options
100100
:ref:`environment variable <mcli-env-var>`.
101101
- no
102102

103-
.. _mcli-atlas-cluster-onlinearchive-create-output:
103+
.. _mcli-atlas-onlinearchive-create-output:
104104

105105
Output
106106
------
@@ -109,7 +109,7 @@ Output
109109

110110
.. include:: /includes/atlas-online-archive-output.rst
111111

112-
.. _mcli-atlas-cluster-onlinearchive-create-egs:
112+
.. _mcli-atlas-onlinearchive-create-egs:
113113

114114
Examples
115115
--------
@@ -129,7 +129,7 @@ The following examples show two ways to create an online archive using the ``mon
129129

130130
The previous command prints the following fields in |json| format to the
131131
terminal. To learn more about these fields, see
132-
:ref:`mcli-atlas-cluster-onlinearchive-create-output`.
132+
:ref:`mcli-atlas-onlinearchive-create-output`.
133133

134134
.. code-block:: sh
135135
:copyable: false
@@ -161,7 +161,7 @@ The following examples show two ways to create an online archive using the ``mon
161161

162162
The previous command prints the following fields in |json| format to the
163163
terminal. To learn more about these fields, see
164-
:ref:`mcli-atlas-cluster-onlinearchive-create-output`.
164+
:ref:`mcli-atlas-onlinearchive-create-output`.
165165

166166
.. code-block:: sh
167167
:copyable: false

source/reference/atlas/onlinearchive-pause.txt

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

source/reference/atlas/onlinearchive-start.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _mcli-atlas-cluster-onlinearchive-start-command:
1+
.. _mcli-atlas-onlinearchive-start-command:
22

3-
==========================================
4-
mongocli atlas cluster onlinearchive start
5-
==========================================
3+
==================================
4+
mongocli atlas onlinearchive start
5+
==================================
66

77
.. default-domain:: mongodb
88

@@ -18,19 +18,19 @@ The ``onlinearchive start`` command starts the archiving process for the
1818
specified :atlas:`online archive </online-archive/manage-online-archive/>`
1919
in the specified cluster.
2020

21-
.. _mcli-atlas-cluster-online-archive-start-syntax:
21+
.. _mcli-atlas-online-archive-start-syntax:
2222

2323
Syntax
2424
------
2525

2626
.. code-block:: text
2727

28-
mongocli atlas cluster onlinearchive start <online-archive-id>
28+
mongocli atlas onlinearchive start <online-archive-id>
2929
--clusterName <cluster-name>
3030
[ --profile|-P <profile-name> ]
3131
[ --projectId <project-ID> ]
3232

33-
.. _mcli-atlas-cluster-onlinearchive-start-options:
33+
.. _mcli-atlas-onlinearchive-start-options:
3434

3535
Options
3636
-------
@@ -50,7 +50,7 @@ Options
5050
</online-archive/manage-online-archive/>` to start.
5151
- yes
5252

53-
* - ``--clusterName``
53+
* - ``clusterName``
5454
- string
5555
- Name of the cluster.
5656
- yes
@@ -70,7 +70,7 @@ Options
7070
:ref:`environment variable <mcli-env-var>`.
7171
- no
7272

73-
.. _mcli-atlas-cluster-onlinearchive-start-output:
73+
.. _mcli-atlas-onlinearchive-start-output:
7474

7575
Output
7676
------
@@ -79,7 +79,7 @@ Output
7979

8080
.. include:: /includes/atlas-online-archive-output.rst
8181

82-
.. _mcli-atlas-cluster-onlinearchive-start-egs:
82+
.. _mcli-atlas-onlinearchive-start-egs:
8383

8484
Example
8585
-------
@@ -95,7 +95,7 @@ project.
9595

9696
The previous command prints the following fields in |json| format to the
9797
terminal. To learn more about these fields, see
98-
:ref:`mcli-atlas-cluster-onlinearchive-start-output`.
98+
:ref:`mcli-atlas-onlinearchive-start-output`.
9999

100100
.. code-block:: json
101101
:copyable: false

0 commit comments

Comments
 (0)