Skip to content

Commit 88fe158

Browse files
authored
(DOCSP-38401) Documents config file for projects update (#348)
* (DOCSP-38401) Documents config file for projects update * Copy review changes
1 parent e6c7eb2 commit 88fe158

File tree

5 files changed

+91
-55
lines changed

5 files changed

+91
-55
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Follow these steps to |action| with a configuration file:
2+
3+
.. procedure::
4+
:style: normal
5+
6+
.. step:: Copy the sample request for |openapi-link|.
7+
8+
a. Navigate to the |openapi-link|
9+
section of the |service| Admin API specification.
10+
b. Under :guilabel:`Request samples` on the right side, click
11+
:guilabel:`Expand all`.
12+
c. Click :guilabel:`Copy` to copy the sample request.
13+
14+
.. step:: Create the configuration file.
15+
16+
a. Paste the sample request into a text editor and change
17+
the values to reflect your desired configuration.
18+
b. Save the file with a ``.json`` extension.
19+
20+
.. step:: Run the |atlas-cli command| command with
21+
the ``--file`` option.
22+
23+
Specify the path to the file you saved with the ``--file`` flag.
24+

source/reference/json.txt

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ you can pass a configuration file when using the {+atlas-cli+} to:
2525
- :ref:`Create <atlas-alerts-settings-create>` or
2626
:ref:`update an alert configuration <atlas-alerts-settings-update>`.
2727
- :ref:`Create a rolling index <atlas-clusters-indexes-create>` for a cluster.
28+
- :ref:`Update a project <atlas-projects-update>`
2829

2930
Usage
3031
-----
@@ -77,6 +78,9 @@ command. The commands you can use include but are not limited to:
7778
* - :ref:`atlas-clusters-indexes-create`
7879
- :oas-atlas-op:`Create One Rolling Index </createRollingIndex>`
7980

81+
* - :ref:`atlas-projects-update`
82+
- :oas-atlas-tag:`Update One Project </Projects/operation/updateProject>`
83+
8084
When you run the command in your terminal, specify the ``--file`` option
8185
and provide the path to the |json| configuration file that defines your
8286
desired settings.
@@ -123,35 +127,35 @@ Cloud Backup Schedule Configuration File
123127
----------------------------------------
124128

125129
To learn more about cloud backup schedule configuration files, see
126-
:ref:`atlas-cli-cloud-backup-schedule-config-file`. For a sample file,
127-
see :ref:`example-cloud-backup-schedule-config-file`.
130+
:ref:`atlas-cli-cloud-backup-schedule-config-file`. To learn the syntax
131+
for a file, see :ref:`example-cloud-backup-schedule-config-file`.
128132

129133
Atlas Search Index Configuration File
130134
-------------------------------------
131135

132136
To learn more about |fts| index configuration files, see
133-
:ref:`atlas-cli-search-index-config-file`. For a sample file,
134-
see :ref:`example-search-index-config-file`.
137+
:ref:`atlas-cli-search-index-config-file`. To learn the syntax for a
138+
file, see :ref:`example-search-index-config-file`.
135139

136140
Search Nodes Configuration File
137141
-------------------------------
138142

139143
To learn more about search nodes configuration files, see
140-
:ref:`atlas-cli-search-nodes-config-file`. For a sample file,
141-
see :ref:`example-search-nodes-config-file`.
144+
:ref:`atlas-cli-search-nodes-config-file`. To learn the syntax for a
145+
file, see :ref:`example-search-nodes-config-file`.
142146

143147
{+adf+} Configuration File
144148
----------------------------------------
145149

146150
To learn more about {+adf+} configuration files, see
147-
:ref:`atlas-cli-data-federation-config-file`. For a sample file,
148-
see :ref:`example-fdi-config-file`.
151+
:ref:`atlas-cli-data-federation-config-file`. To learn the syntax for a
152+
file, see :ref:`example-fdi-config-file`.
149153

150154
Alert Configuration File
151155
------------------------
152156

153157
To learn more about alert configuration files, see
154-
:ref:`atlas-cli-alert-config-file`. For a sample file,
158+
:ref:`atlas-cli-alert-config-file`. To learn the syntax for a file,
155159
see :ref:`example-alert-config-file`.
156160

157161
Rolling Index Configuration File
@@ -164,6 +168,13 @@ To learn more about rolling index configuration files, see
164168
- `Sparse Index <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_sparse_index.json>`__
165169
- `Partial indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_partial_index.json>`__
166170

171+
Project Configuration File
172+
--------------------------
173+
174+
To learn more about project configuration files, see
175+
:ref:`atlas-cli-project-config-file`. To learn the syntax for a file,
176+
see :ref:`example-project-config-file`.
177+
167178

168179
.. toctree::
169180
:titlesonly:
@@ -176,3 +187,4 @@ To learn more about rolling index configuration files, see
176187
Online Archive </reference/json/file-options-online-archive>
177188
Alert </reference/json/alert-config-file>
178189
Rolling Index </reference/json/rolling-index-config-file>
190+
Project </reference/json/project-config-file>

source/reference/json/cloud-backup-schedule-config-file.txt

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,26 +41,4 @@ can specify any settings that are listed in
4141
Create a Configuration File
4242
---------------------------
4343

44-
Follow these steps to |action| with a configuration file:
45-
46-
.. procedure::
47-
:style: normal
48-
49-
.. step:: Copy the sample request for |openapi-link|.
50-
51-
a. Navigate to the |openapi-link|
52-
section of the |service| Admin API specification.
53-
b. Under :guilabel:`Request samples` on the right side, click
54-
:guilabel:`Expand all`.
55-
c. Click :guilabel:`Copy` to copy the sample request.
56-
57-
.. step:: Create the configuration file.
58-
59-
a. Paste the copied sample request into a text editor and change
60-
the values to reflect your values.
61-
b. Save the file with a ``.json`` extension.
62-
63-
.. step:: Run the |atlas-cli command| command with
64-
the ``--file`` option.
65-
66-
Specify the path to the file you saved with the ``--file`` flag.
44+
.. include:: /includes/steps-config-file-template.rst
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. _atlas-cli-project-config-file:
2+
3+
==========================
4+
Project Configuration File
5+
==========================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: tutorial
16+
17+
.. To create a configuration file doc, copy this template, change
18+
.. the replacements below, and update the H1 title and refs.
19+
20+
.. |atlas-cli command| replace:: :ref:`atlas-projects-update`
21+
.. |configuration-file-name| replace:: project configuration
22+
.. |openapi-link| replace:: :oas-atlas-tag:`Update One Project </Projects/operation/updateProject>`
23+
.. |action| replace:: update a project
24+
25+
You can use a |configuration-file-name| file to specify the
26+
settings required when you |action|
27+
using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json``
28+
|configuration-file-name| files.
29+
30+
.. _project-settings:
31+
32+
Available Settings
33+
------------------
34+
35+
When you |action| using a configuration file, you
36+
can specify any settings that are listed in
37+
|openapi-link| under :guilabel:`Request Body Schema`.
38+
39+
.. _example-project-config-file:
40+
41+
Create a Configuration File
42+
---------------------------
43+
44+
.. include:: /includes/steps-config-file-template.rst

source/reference/json/rolling-index-config-file.txt

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,4 @@ can specify any settings that are listed in
4343
Create a Configuration File
4444
---------------------------
4545

46-
Follow these steps to |action| with a configuration file:
47-
48-
.. procedure::
49-
:style: normal
50-
51-
.. step:: Copy the sample request for |openapi-link|.
52-
53-
a. Navigate to the |openapi-link|
54-
section of the |service| Admin API specification.
55-
b. Under :guilabel:`Request samples` on the right side, click
56-
:guilabel:`Expand all`.
57-
c. Click :guilabel:`Copy` to copy the sample request.
58-
59-
.. step:: Create the configuration file.
60-
61-
a. Paste the copied sample request into a text editor and change
62-
the values to reflect your values.
63-
b. Save the file with a ``.json`` extension.
64-
65-
.. step:: Run the |atlas-cli command| command with
66-
the ``--file`` option.
67-
68-
Specify the path to the file you saved with the ``--file`` flag.
46+
.. include:: /includes/steps-config-file-template.rst

0 commit comments

Comments
 (0)