Skip to content

Commit 4e893b8

Browse files
authored
(DOCSP-47879) SEO improvements (#126)
* (DOCSP-47879) SEO improvements * Changes Features and Recommendations to Guidance for pages that have both * Lengthens pillar page titles
1 parent 935f9e7 commit 4e893b8

27 files changed

+279
-297
lines changed

config/redirects

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,8 @@ symlink: current -> main
99
raw: ${bucket_prefix}/ -> ${base}/current/
1010
raw: ${bucket_prefix}/index.html -> ${base}/current/
1111

12+
########
13+
14+
# All Arch Center versions
15+
16+
[*]: ${bucket_prefix}/${version}/changelog -> ${base}/${version}/release-notes/

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ play-store = "https://play.google.com/store/apps/"
170170
vault = "`HashiCorp Vault <https://www.vaultproject.io/>`__"
171171
vpc = ":abbr:`VPC (Virtual Private Cloud)`"
172172
vnet = "VNet"
173-
waf = "Atlas Well-Architected Framework"
173+
waf = "`Well-Architected Framework <https://www.mongodb.com/resources/products/capabilities/well-architected-framework>`__"
174174
wif = "Workforce Identity Federation"
175175
workload = "Workload Identity Federation"
176176

source/auditing-logging.txt

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _arch-center-auditing-logging:
22

3-
====================
4-
Auditing and Logging
5-
====================
3+
=============================================
4+
Guidance for {+service+} Auditing and Logging
5+
=============================================
66

77
.. default-domain:: mongodb
88

@@ -14,16 +14,13 @@ Auditing and Logging
1414

1515
To monitor and log |service| platform activities, use auditing and logs.
1616

17-
{+service+} Features and Recommendations for Auditing and Logging
18-
-----------------------------------------------------------------
19-
20-
Features
21-
~~~~~~~~
17+
Features for {+service+} Auditing and Logging
18+
---------------------------------------------
2219

2320
.. _auditing:
2421

2522
Auditing
26-
````````
23+
~~~~~~~~
2724

2825
Available on ``M10+`` {+clusters+}, database auditing lets you track system
2926
activity for deployments with
@@ -58,7 +55,7 @@ multiple users. As an |service| administrator, you can:
5855
.. _accessing-audit-logs:
5956

6057
Accessing Audit Logs
61-
````````````````````
58+
~~~~~~~~~~~~~~~~~~~~
6259

6360
.. include:: /includes/cloud-docs/logs.rst
6461

@@ -83,8 +80,10 @@ To perform a full audit, you can use a combination of audit logs,
8380
:manual:`MongoDB log messages </reference/log-messages/>`, and
8481
:ref:`the project and organization activity feed <view-activity-feed>`.
8582

86-
Recommendations for Auditing
87-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83+
.. _arch-center-auditing-logging-recs:
84+
85+
Recommendations for {+service+} Auditing and Logging
86+
----------------------------------------------------
8887

8988
We recommend that you :atlas:`set up database auditing </database-auditing>`
9089
when you provision your {+clusters+}.
@@ -133,8 +132,8 @@ information at a minimum:
133132
- Timestamp
134133
- Error code (if applicable)
135134

136-
Recommendations for Programmatic Access to Audit Logs
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135+
Programmatic Access to Audit Logs
136+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138137

139138
To integrate with tools beyond the built-in integrations, we recommend
140139
that you retrieve logs with the following programmatic tools and feed
@@ -148,8 +147,8 @@ the JSON-formatted output to your external tools:
148147
- To retrieve deployment logs, use :ref:`atlas deployment logs <atlas-deployments-logs>`
149148
command in the {+atlas-cli+}. To learn more, see :atlas:`Atlas Deployment Logs </cli/current/command/atlas-deployments-logs/>`.
150149

151-
Examples
152-
--------
150+
Automation Examples: {+service+} Auditing and Logging
151+
-----------------------------------------------------
153152

154153
.. include:: /includes/complete-examples.rst
155154

source/auth.txt

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
.. _arch-center-auth:
22

3-
================================
4-
Authorization and Authentication
5-
================================
3+
=========================================================
4+
Guidance for {+service+} Authorization and Authentication
5+
=========================================================
66

77
.. default-domain:: mongodb
88

99
.. facet::
1010
:name: genre
1111
:values: reference
1212

13-
.. meta::
14-
:keywords: atlas architecture center
13+
.. meta:
1514
:description: Learn about the different authorization and authentication mechanisms that Atlas supports.
1615

1716
.. contents:: On this page
@@ -43,11 +42,8 @@ authentication is distinct from authorization:
4342
user's access to database resources and operations. Outside of role
4443
assignments, the user has no access to the system.
4544

46-
{+service+} Features and Recommendations for Authentication
47-
-----------------------------------------------------------
48-
49-
Features
50-
~~~~~~~~
45+
Features for {+service+} Authentication
46+
---------------------------------------
5147

5248
|service-fullname| supports a variety of authentication methods to
5349
ensure robust security.
@@ -66,8 +62,13 @@ authentication methods for each |service| resource ensure that
6662
authentication is both secure and adaptable. |service| provides the
6763
following authentication mechanisms:
6864

69-
Recommendations for {+atlas-ui+}
70-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
.. _arch-center-authentication-recs:
66+
67+
Recommendations for {+service+} Authentication
68+
----------------------------------------------
69+
70+
{+atlas-ui+} Authentication
71+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
7172

7273
We recommend federated authentication for {+atlas-ui+} access. To
7374
configure federated authentication, you must create {+service+}
@@ -104,7 +105,7 @@ from IP ranges that include your users and application servers.
104105

105106
To learn more, see :ref:`atlas-federated-authentication`.
106107

107-
Multi-Factor authentication
108+
Multi-Factor Authentication
108109
```````````````````````````
109110

110111
For any human user that has access to the |service| control plane, we recommend
@@ -124,8 +125,8 @@ two forms of identification:
124125

125126
To learn more, see :ref:`atlas-enable-mfa`.
126127

127-
Recommendations for |service| Database
128-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128+
|service| Database Authentication
129+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129130

130131
|service| supports various database authentication mechanisms.
131132

@@ -242,8 +243,8 @@ MongoDB Atlas Database Secrets in HashiCorp Vault
242243

243244
.. _arch-center-admin-api-recs:
244245

245-
Recommendations for {+atlas-admin-api+}
246-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
246+
{+atlas-admin-api+} Authentication
247+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247248

248249
|service| provides two ways to authenticate to the {+atlas-admin-api+}:
249250

@@ -289,16 +290,15 @@ minimize the risk of unauthorized access:
289290

290291
To learn more, see :ref:`api-authentication`.
291292

292-
Recommendations for Deployments
293-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
293+
Deployments
294+
~~~~~~~~~~~
294295

295296
To learn our recommendations for deployments, which relate to authentication, see :ref:`arch-center-hierarchy`.
296297

297-
{+service+} Features and Recommendations for Authorization
298-
----------------------------------------------------------
298+
.. _arch-center-authorization-recs:
299299

300-
Features
301-
~~~~~~~~
300+
Recommendations for {+service+} Authorization
301+
---------------------------------------------
302302

303303
You must implement |service|'s robust Role-Based Access Control (RBAC)
304304
to effectively manage access across all resources. |service| includes
@@ -320,8 +320,8 @@ environments to only programmatic service accounts with scripts that
320320
are tested for security and deterministic outcomes. Human access should
321321
only be allowed in lower environments during development and testing.
322322

323-
Recommendations for {+atlas-ui+} and {+atlas-admin-api+} (Control Plane)
324-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323+
{+atlas-ui+} and {+atlas-admin-api+} (Control Plane) Authorization
324+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
325325

326326
You can assign users, service accounts, and API keys to predefined
327327
roles, specifying the
@@ -400,8 +400,8 @@ commonly used roles can serve as a general guideline:
400400

401401
To learn more, see :ref:`user-roles`.
402402

403-
Recommendations for Database
404-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
403+
Database Authorization
404+
~~~~~~~~~~~~~~~~~~~~~~
405405

406406
Workforce and workload users can be assigned fine-grained database
407407
roles, predefined or custom, with permissions tailored to specific
@@ -426,8 +426,8 @@ To learn more, see the following:
426426
- :ref:`mongodb-users-roles-and-privileges`
427427
- :ref:`mongodb-roles`
428428

429-
Examples
430-
--------
429+
Automation Examples: {+service+} Authentication and Authorization
430+
-----------------------------------------------------------------
431431

432432
.. include:: /includes/complete-examples.rst
433433

source/automation.txt

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _arch-center-automation:
22

3-
=====================================
4-
Automated Infrastructure Provisioning
5-
=====================================
3+
==============================================================
4+
Guidance for {+service+} Automated Infrastructure Provisioning
5+
==============================================================
66

77
.. default-domain:: mongodb
88

@@ -11,7 +11,6 @@ Automated Infrastructure Provisioning
1111
:values: reference
1212

1313
.. meta::
14-
:keywords: atlas architecture center
1514
:description: Learn about the different Atlas tools to automate the provisioning and management of Atlas clusters and projects.
1615

1716
.. contents:: On this page
@@ -31,11 +30,8 @@ directly), or Infrastructure as Code (IaC) tooling that uses declarative
3130
configuration, like our Kubernetes Operator, Terraform, Cloud Formation
3231
or AWS CDK.
3332

34-
{+service+} Features and Recommendations for Automation
35-
-------------------------------------------------------
36-
37-
Features
38-
~~~~~~~~
33+
Features for Atlas Automation
34+
-----------------------------
3935

4036
You can automate the management, provisioning, and configuration of
4137
|service| building blocks like database users and roles, |service|
@@ -52,7 +48,7 @@ deploy and manage |service| at scale with repeatable, accurate, and
5248
scalable processes.
5349

5450
{+atlas-admin-api+}
55-
`````````````````````````````
51+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5652

5753
The {+atlas-admin-api+} provides a |rest|\ful interface that allows you
5854
to leverage your preferred client such as cURL or Postman to
@@ -65,7 +61,7 @@ To learn more, see :ref:`atlas-admin-api-access`.
6561
.. _arch-center-iac:
6662

6763
HashiCorp Terraform MongoDB Atlas Provider
68-
``````````````````````````````````````````
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6965

7066
Provisions |service| resources across cloud providers (|aws|, |azure|,
7167
|gcp|) in the workflow of your choice. It allows you to integrate
@@ -95,7 +91,7 @@ applications quickly and easily.
9591
To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
9692

9793
CloudFormation Resources
98-
````````````````````````
94+
~~~~~~~~~~~~~~~~~~~~~~~~
9995

10096
Resources to manage |service| include:
10197

@@ -110,7 +106,7 @@ Resources to manage |service| include:
110106
To learn more, see `Deploy MongoDB Atlas with AWS CloudFormation <https://www.mongodb.com/developer/products/atlas/deploy-mongodb-atlas-aws-cloudformation/>`__.
111107

112108
{+atlas-cli+}
113-
`````````````
109+
~~~~~~~~~~~~~
114110

115111
Enables you to manually or programmatically create, manage, and automate
116112
tasks related to |service| resources from a unified command line tool.
@@ -126,7 +122,7 @@ examples in the {+atlas-arch-center+} such as the :ref:`Org, Project,
126122
and Cluster<arch-center-hierarchy>` examples to get started.
127123

128124
|ak8so|
129-
`````````````````````````
125+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130126

131127
Allows you to deploy and manage |service| resources using you existing
132128
Kubernetes tools. The Operator enables management of |service| through
@@ -135,8 +131,10 @@ configure |service|.
135131

136132
To learn more, see :ref:`ak8so-quick-start-ref`.
137133

138-
Recommendations
139-
~~~~~~~~~~~~~~~
134+
.. _arch-center-automation-recs:
135+
136+
Recommendations for {+service+} Automation
137+
------------------------------------------
140138

141139
If you already have an existing tool integrated into your deployment
142140
workflow that you use today, we recommend that you use that tool for

source/backups.txt

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _arch-center-backups:
22

3-
=======
4-
Backups
5-
=======
3+
================================
4+
Guidance for {+service+} Backups
5+
================================
66

77
.. default-domain:: mongodb
88

@@ -11,7 +11,6 @@ Backups
1111
:values: reference
1212

1313
.. meta::
14-
:keywords: atlas architecture center
1514
:description: Learn the best practices for configuring backups for you Atlas cluster.
1615

1716
.. contents:: On this page
@@ -42,11 +41,8 @@ environments. For staging and production environments, we recommend
4241
developing automated deployment templates that include the
4342
recommendations described in this page.
4443

45-
{+service+} Features and Recommendations for Backups
46-
----------------------------------------------------
47-
48-
Features
49-
~~~~~~~~
44+
Features for {+service+} Backups
45+
--------------------------------
5046

5147
|service| provides fully-managed backups of your data, including
5248
point-in-time data recovery and consistent, cluster-wide snapshots of
@@ -99,6 +95,11 @@ monthly, each with its own retention period.
9995
and cooldown period so that an attacker cannot change the backup
10096
policy and export the data. To learn more, see `Configure a Backup Compliance Policy <https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/>`__.
10197

98+
.. _arch-center-backups-recs:
99+
100+
Recommendations for {+service+} Backups
101+
---------------------------------------
102+
102103
Recommendations for Backup Strategy
103104
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104105

@@ -244,8 +245,8 @@ right {+cluster+} disk size based on workload to prevent overspending.
244245
By implementing these strategies, you can effectively manage costs while
245246
maintaining secure and reliable backups.
246247

247-
Examples
248-
--------
248+
Automation Examples: {+service+} Backups
249+
----------------------------------------
249250

250251
.. include:: /includes/complete-examples.rst
251252

0 commit comments

Comments
 (0)