Skip to content

Commit 7e0018f

Browse files
Fix warnings (#1)
* docurl * change doc role to atlas role * fix more errors * fix more stuff * trying this again
1 parent cc9b4ce commit 7e0018f

21 files changed

+277
-2624
lines changed

assets.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[assets.output_paths]
2+
repository_path = "source/includes"
3+
4+
[[assets.sources.repository]]
5+
repo = "mongodb/mongodb-atlas-cli"
6+
version = "atlascli/v1.14.0"
7+
8+
[[assets.sources.repository.targets]]
9+
source = "docs/atlascli/command/atlas-kubernetes-operator-install.txt"
10+
output = "command/atlas-kubernetes-operator-install.txt"

source/ak8so-changelog.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ New Features
214214

215215
:ref:`atlasdeployment-custom-resource`:
216216

217-
- Adds support for :doc:`Global {+Cluster+} </global-clusters>`
217+
- Adds support for :atlas:`Global {+Cluster+} </global-clusters>`
218218
parameters in ``spec.advancedDeploymentSpec.*`` and ``spec.deploymentSpec.*``.
219219
To learn more, see :ref:`AtlasDeployment custom resource parameters <atlasdeployment-crd-params>`.
220220
These Global Cluster parameters map zones to geographic regions and allow you

source/atlasdeployment-custom-resource.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ documentation to customize your specifications.
408408
- Required
409409

410410
* - You are deploying
411-
:doc:`Global {+Clusters+} </global-clusters>`.
411+
:atlas:`Global {+Clusters+} </global-clusters>`.
412412
- Required
413413

414414
* - You are deploying non-Global replica sets and sharded
@@ -424,11 +424,11 @@ documentation to customize your specifications.
424424
* - Value
425425
- {+Cluster+} Type
426426
* - REPLICASET
427-
- :term:`replica set`
427+
- replica set
428428
* - SHARDED
429-
- :term:`sharded cluster`
429+
- sharded cluster
430430
* - GEOSHARDED
431-
- :doc:`global {+cluster+} </global-clusters>`
431+
- :atlas:`global {+cluster+} </global-clusters>`
432432

433433
.. setting:: spec.deploymentSpec.customZoneMapping
434434

@@ -707,7 +707,7 @@ documentation to customize your specifications.
707707
- Values
708708

709709
* - You are deploying
710-
:doc:`Global {+Clusters+} </global-clusters>`.
710+
:atlas:`Global {+Clusters+} </global-clusters>`.
711711
- Required
712712
- Each object in the array represents a zone where
713713
|service| deploys your {+cluster+}'s nodes.
@@ -739,11 +739,11 @@ documentation to customize your specifications.
739739

740740
- If you specify a value of ``1`` and you set
741741
:setting:`spec.deploymentSpec.clusterType` to ``SHARDED``,
742-
|service| deploys a single-shard :term:`sharded cluster`.
742+
|service| deploys a single-shard sharded cluster.
743743

744744
- If you specify ``1`` and you set
745745
:setting:`spec.deploymentSpec.clusterType` to ``REPLICASET``,
746-
|service| deploys a :term:`replica set`.
746+
|service| deploys a replica set.
747747

748748
.. include:: /includes/cluster-settings/single-shard-cluster-warning.rst
749749

@@ -786,7 +786,7 @@ documentation to customize your specifications.
786786
Hardware specifications for :ref:`analytics nodes
787787
<analytics-nodes-overview>` needed in the region. Analytics nodes
788788
handle analytic data such as reporting queries from |bic|. Analytics
789-
nodes are read-only and can never become the :term:`primary`.
789+
nodes are read-only and can never become the primary.
790790

791791
If you don't specify this parameter, |service| deploys no analytics
792792
to this region.
@@ -884,7 +884,7 @@ documentation to customize your specifications.
884884
*Optional*
885885

886886
Hardware specifications for electable nodes in the region.
887-
Electable nodes can become the :term:`primary` and can enable
887+
Electable nodes can become the primary and can enable
888888
local reads.
889889

890890
If you don't specify this option, |service| deploys no electable
@@ -903,7 +903,7 @@ documentation to customize your specifications.
903903
:ref:`GCP <google-gcp>`, and :ref:`Azure <microsoft-azure>` custom
904904
storage sizes.
905905

906-
If you deploy a :term:`sharded cluster`, or :doc:`global {+cluster+}
906+
If you deploy a sharded cluster, or :atlas:`global {+cluster+}
907907
</global-clusters>`, you must choose an instance size of ``M30`` or
908908
greater.
909909

@@ -919,7 +919,7 @@ documentation to customize your specifications.
919919
*Conditional*
920920

921921
Number of electable nodes for |service| to deploy to the region.
922-
Electable nodes can become the :term:`primary` and can enable
922+
Electable nodes can become the primary and can enable
923923
local reads.
924924

925925
The combined ``electableSpecs.nodeCount`` across all
@@ -959,7 +959,7 @@ documentation to customize your specifications.
959959
have a priority of ``7``. The lowest possible priority is ``1``.
960960

961961
The priority ``7`` region identifies the **Preferred Region** of
962-
the {+cluster+}. |service| places the :term:`primary` node in the
962+
the {+cluster+}. |service| places the primary node in the
963963
**Preferred Region**. Priorities ``1`` through ``7`` are
964964
exclusive: you can't assign a given priority to more than one
965965
region per {+cluster+}.
@@ -978,7 +978,7 @@ documentation to customize your specifications.
978978
*Optional*
979979

980980
Hardware specifications for read-only nodes in the region.
981-
Read-only nodes can never become the :term:`primary` member, but
981+
Read-only nodes can never become the primary member, but
982982
can enable local reads.
983983

984984
If you don't specify this parameter, |service| deploys no read-only
@@ -991,7 +991,7 @@ documentation to customize your specifications.
991991
*Optional*
992992

993993
Human-readable label that identifies the zone in a
994-
:doc:`Global {+Cluster+} </global-clusters>`. Provide this value
994+
:atlas:`Global {+Cluster+} </global-clusters>`. Provide this value
995995
only if you set :setting:`spec.deploymentSpec.clusterType` to
996996
``GEOSHARDED``.
997997

source/atlasproject-custom-resource.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1223,7 +1223,7 @@ This section describes the ``AtlasProject`` custom resource parameters:
12231223

12241224
Human-readable label that identifies the privilege action. For a
12251225
complete list of actions available in the {+atlas-admin-api+}, see
1226-
:doc:`/reference/custom-role-actions`.
1226+
:atlas:`/reference/custom-role-actions`.
12271227

12281228
.. setting:: spec.customRoles.actions.resources
12291229

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Number of :ref:`analytics nodes <analytics-nodes-overview>` for
22
|service| to deploy to the region. Analytics nodes are useful for
33
handling analytic data such as reporting queries from |bic|. Analytics
4-
nodes are read-only, and can never become the :term:`primary`.
4+
nodes are read-only, and can never become the primary.

source/includes/cluster-settings/global-cluster/extracts-settings.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ content: |
55
66
*Required*
77
8-
List that contains :doc:`Global {+Cluster+} </global-clusters>`
8+
List that contains :atlas:`Global {+Cluster+} </global-clusters>`
99
parameters that map zones to geographic regions. For a full list of
1010
available parameters, see the |service| :oas-atlas-tag:`Global
1111
{+Clusters+} API </Global-Clusters>`.
@@ -18,7 +18,7 @@ content: |
1818
1919
*Required*
2020
21-
Code that represents a location that maps to a zone in your :doc:`Global
21+
Code that represents a location that maps to a zone in your :atlas:`Global
2222
{+Cluster+} </global-clusters>`.
2323
2424
---
@@ -29,7 +29,7 @@ content: |
2929
3030
*Required*
3131
32-
Human-readable label that identifies the zone in your :doc:`Global
32+
Human-readable label that identifies the zone in your :atlas:`Global
3333
{+Cluster+} </global-clusters>`.
3434
3535
---
@@ -41,7 +41,7 @@ content: |
4141
*Required*
4242
4343
List that contains information to create a managed namespace in a
44-
specified :doc:`Global {+Cluster+} </global-clusters>` to create. For
44+
specified :atlas:`Global {+Cluster+} </global-clusters>` to create. For
4545
a full list of available parameters, see the |service|
4646
:oas-atlas-tag:`Global {+Clusters+} API
4747
</Global-Clusters>`.
@@ -54,7 +54,7 @@ content: |
5454
5555
*Required*
5656
57-
Human-readable label of the collection to manage in this :doc:`Global
57+
Human-readable label of the collection to manage in this :atlas:`Global
5858
{+Cluster+} </global-clusters>`.
5959
6060
---
@@ -65,7 +65,7 @@ content: |
6565
6666
*Required*
6767
68-
Human-readable label of the database to manage in this :doc:`Global
68+
Human-readable label of the database to manage in this :atlas:`Global
6969
{+Cluster+} </global-clusters>`.
7070
7171
---
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
If this is the first dedicated paid cluster for the selected region or
22
regions *and* you plan on creating one or more
3-
:abbr:`VPC peering connections`, review :doc:`VPC Peering Connections </security-vpc-peering>` before continuing.
3+
:abbr:`VPC peering connections`, review :atlas:`VPC Peering Connections </security-vpc-peering>` before continuing.

source/includes/cluster-settings/group-region-association.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Multi-Region Clusters
2020
resides in the same region as the nodes to communicate with the
2121
peered |vpc|.
2222

23-
To learn more, see :doc:`/security-vpc-peering`.
23+
To learn more, see :atlas:`/security-vpc-peering`.

source/includes/cluster-settings/instance-size-parameter-advanced.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ size.
55

66
**See Also:** :ref:`server-number-costs`.
77

8-
If you deploy a :doc:`Global Cluster </global-clusters>`, you must
8+
If you deploy a :atlas:`Global Cluster </global-clusters>`, you must
99
choose a instance size of **M30** or greater.
1010

1111
.. tabs-cloud-providers::

source/includes/cluster-settings/instance-size-parameter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ size.
55

66
**See Also:** :ref:`server-number-costs`.
77

8-
If you deploy a :doc:`Global Cluster </global-clusters>`, you must
8+
If you deploy a :atlas:`Global Cluster </global-clusters>`, you must
99
choose a instance size of **M30** or greater.
1010

1111
.. tabs-cloud-providers::

0 commit comments

Comments
 (0)