Skip to content

Commit c5f724d

Browse files
elyse-mdbelyse-mdb
authored
(DOCPS-44173) [Atlas Operator] "Important" nested components (#144)
* (DOCPS-44173) Unnested 1 important admonition in table. * (DOCSP-44173) Unnested 1 important admonition in table. * (DOCSP-44173) Unnested imoprtant admonitions. * (DOCSP-44173) Build warning fixes. * (DOCSP-44173) Fixing build warning, following comment (https://github.com/10gen/docs-atlas-operator/pull/142/files/d526ec2147f29f4d5ac51178e0b252d395c16b84\#r1764000645) in #142 * (DOCSP-44173) build warning fix. --------- Co-authored-by: Elyse Foreman <[email protected]>
1 parent 4592b39 commit c5f724d

9 files changed

+32
-48
lines changed

‎source/ak8so-create-atlas-search-index.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,9 @@ Procedure
105105
database that contains the collection with one or more
106106
|fts| indexes.
107107

108-
.. important::
109-
110-
The database that you specify must already exist. If
111-
you don't have an existing database,
112-
:atlas:`create one </create-connect-deployments/>`.
108+
:gold:`IMPORTANT:` The database that you specify must already exist. If
109+
you don't have an existing database,
110+
:atlas:`create one </create-connect-deployments/>`.
113111

114112
* - ``CollectionName``
115113
- Human-readable label that identifies the collection that

‎source/ak8so-create-vector-search-index.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,9 @@ Procedure
6868
database that contains the collection with one or more
6969
|fts| indexes.
7070

71-
.. important::
72-
73-
The database that you specify must already exist. If
74-
you don't have an existing database,
75-
:atlas:`create one </create-connect-deployments/>`.
71+
:gold:`IMPORTANT:` The database that you specify must already exist. If
72+
you don't have an existing database,
73+
:atlas:`create one </create-connect-deployments/>`.
7674

7775
* - ``CollectionName``
7876
- Human-readable label that identifies the collection that

‎source/ak8so-encryption-at-rest-customer-keys.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,9 @@ following procedure:
321321
- |json| file that contains the {+gcp+} |kms|
322322
credentials from your {+gcp+} account.
323323

324-
.. important::
325-
326-
You must format the |json| object properly.
327-
Ensure you properly indent the credential fields
328-
within the file.
324+
:gold:`IMPORTANT:` You must format the |json| object properly.
325+
Ensure you properly indent the credential fields
326+
within the file.
329327

330328
The following example shows the contents of a
331329
``ServiceAccountKey`` |json| file:

‎source/ak8so-private-link-datafederation.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,12 @@ private endpoints:
102102
:guilabel:`Subnet` dashboard in your |aws|
103103
account.
104104

105-
.. important::
106-
107-
You must specify at least one subnet. If you
108-
don't, |aws| won't provision a
109-
:term:`interface endpoint` in your |vpc|. An
110-
interface endpoint is required for clients
111-
in your |vpc| to send traffic to the private
112-
endpoint.
105+
:gold:`IMPORTANT:` You must specify at least one subnet. If you
106+
don't, |aws| won't provision a
107+
:term:`interface endpoint` in your |vpc|. An
108+
interface endpoint is required for clients
109+
in your |vpc| to send traffic to the private
110+
endpoint.
113111

114112
#. Run the command with the :aws:`AWS CLI
115113
</cli/latest/userguide/cli-chap-install.html>`.

‎source/ak8so-private-link-dedicated.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,12 @@ private endpoints:
121121
:guilabel:`Subnet` dashboard in your |aws|
122122
account.
123123

124-
.. important::
125-
126-
You must specify at least one subnet. If you
127-
don't, |aws| won't provision a
128-
:term:`interface endpoint` in your |vpc|. An
129-
interface endpoint is required for clients
130-
in your |vpc| to send traffic to the private
131-
endpoint.
124+
:gold:`IMPORTANT:` You must specify at least one subnet. If you
125+
don't, |aws| won't provision a
126+
:term:`interface endpoint` in your |vpc|. An
127+
interface endpoint is required for clients
128+
in your |vpc| to send traffic to the private
129+
endpoint.
132130

133131
#. Run the command with the :aws:`AWS CLI
134132
</cli/latest/userguide/cli-chap-install.html>`.

‎source/ak8so-private-link-serverless.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,12 @@ using private endpoints:
132132
:guilabel:`Subnet` dashboard in your |aws|
133133
account.
134134

135-
.. important::
136-
137-
You must specify at least one subnet. If you
138-
don't, |aws| won't provision a
139-
:term:`interface endpoint` in your |vpc|. An
140-
interface endpoint is required for clients
141-
in your |vpc| to send traffic to the private
142-
endpoint.
135+
:gold:`IMPORTANT:` You must specify at least one subnet. If you
136+
don't, |aws| won't provision a
137+
:term:`interface endpoint` in your |vpc|. An
138+
interface endpoint is required for clients
139+
in your |vpc| to send traffic to the private
140+
endpoint.
143141

144142
#. Run the command with the :aws:`AWS CLI
145143
</cli/latest/userguide/cli-chap-install.html>`.

‎source/atlasdatabaseuser-custom-resource.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ to customize your specifications.
433433
If the database user authenticates with |aws| |iam| credentials,
434434
this value must be the user that authenticates with the |aws| |iam|
435435
credentials or the role of the user that authenticates with the |aws|
436-
|iam| credentials in :aws-docs:`|arn| format <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html#arns-syntax>`__.
436+
|iam| credentials in :aws-docs:`Amazon Resource Name format </IAM/latest/UserGuide/reference-arns.html#arns-syntax>`.
437437

438438
.. setting:: spec.x509Type
439439

‎source/atlasdeployment-custom-resource.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1087,10 +1087,8 @@ examples, and the |api| documentation.
10871087
- Human-readable label that identifies the existing
10881088
database that contains the collection with one or more |fts| indexes.
10891089

1090-
.. important::
1091-
1092-
The database that you specify must already exist. If you don't have an existing database,
1093-
:atlas:`create one </create-connect-deployments/>`.
1090+
:gold:`IMPORTANT:` The database that you specify must already exist. If you don't have an existing database,
1091+
:atlas:`create one </create-connect-deployments/>`.
10941092

10951093
* - ``collectionName``
10961094
- string

‎source/includes/api/list-tables/requests/access-list.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,8 @@
4242
access list. The specified date must be in the future and within
4343
one week of the time you make the |api| request.
4444

45-
.. important::
46-
47-
You cannot set |aws| security groups as temporary access list
48-
entries.
45+
:gold:`IMPORTANT:` You cannot set |aws| security groups as temporary access list
46+
entries.
4947

5048
You may include an |iso8601| time zone designator to ensure
5149
that the expiration date occurs with respect to the local

0 commit comments

Comments
 (0)