Skip to content

Commit d3f2d72

Browse files
author
Chris Cho
authored
DOCSP-21665: add CSFLE ref anchors and substitute for doc roles (#881)
* DOCSP-21665: add CSFLE ref anchors and subustitute for doc roles * build * build * build * fix anchor * close ref * build * build
1 parent c1a64dd commit d3f2d72

12 files changed

+37
-15
lines changed

source/core/security-automatic-client-side-encryption.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Server-Side Field Level Encryption Enforcement
103103
----------------------------------------------
104104

105105
Starting in MongoDB 4.2, the server supports using
106-
:doc:`schema validation </core/schema-validation>` to enforce encryption
106+
:ref:`schema validation <schema-validation-overview>` to enforce encryption
107107
of specific fields in a collection. Clients performing
108108
:ref:`automatic client-side field level
109109
encryption <field-level-encryption-json-schema>` have specific behavior
@@ -138,4 +138,4 @@ encryption enforcement, see
138138

139139
/reference/security-client-side-automatic-json-schema.txt
140140
/reference/security-client-side-query-aggregation-support.txt
141-
/reference/security-client-side-encryption-appendix.txt
141+
/reference/security-client-side-encryption-appendix.txt

source/core/security-client-side-encryption-key-management.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _manual-manage-cmk-and-dek:
2+
13
=============================================
24
Master Key and Data Encryption Key Management
35
=============================================
@@ -20,8 +22,7 @@ Supported Key Management Services
2022
Client-side field level encryption requires a Key Management Service
2123
(KMS) for accessing a Customer Master Key (CMK). MongoDB automatically
2224
encrypts data encryption keys using the specified CMK during
23-
:doc:`data encryption key creation
24-
</reference/method/KeyVault.createKey>`.
25+
:ref:`data encryption key creation <keyvault-createkey-method>`.
2526

2627
Deleting the CMK renders all data encryption keys encrypted with that
2728
CMK as permanently unreadable, which in turn renders all values
@@ -97,7 +98,7 @@ Key must have at least one policy with the following actions:
9798
}
9899

99100
For complete documentation on data encryption key management using AWS
100-
KMS, see :doc:`/tutorial/manage-client-side-encryption-data-keys` and
101+
KMS, see :ref:`Manage Data Encryption Keys <manual-manage-dek>` and
101102
select the "Amazon Web Services KMS" tab.
102103

103104
.. _field-level-encryption-azure-keyvault:
@@ -137,7 +138,7 @@ ability to perform the following actions:
137138

138139
For complete documentation on data encryption key management using
139140
Azure Key Vault, see
140-
:doc:`/tutorial/manage-client-side-encryption-data-keys` and select the
141+
:ref:`Manage Data Encryption Keys <manual-manage-dek>` and select the
141142
"Azure Key Vault" tab.
142143

143144
.. _field-level-encryption-gcp-kms:
@@ -174,7 +175,7 @@ or can be included in a
174175

175176
For complete documentation on data encryption key management using
176177
Google Cloud KMS, see
177-
:doc:`/tutorial/manage-client-side-encryption-data-keys` and select the
178+
:ref:`Manage Data Encryption Keys <manual-manage-dek>` and select the
178179
"Google Cloud KMS" tab.
179180

180181
.. _field-level-encryption-local-kms:
@@ -188,7 +189,7 @@ be a 96-byte long string.
188189

189190
For complete documentation on data encryption key management using a
190191
locally managed key, see
191-
:doc:`/tutorial/manage-client-side-encryption-data-keys` and select the
192+
:ref:`Manage Data Encryption Keys <manual-manage-dek>` and select the
192193
"Local Keyfile" tab.
193194

194195
.. _field-level-encryption-keyvault:
@@ -273,10 +274,10 @@ index does not exist, applications *must* create it prior to performing
273274
data encryption key management.
274275

275276
For complete documentation on data encryption key management, see
276-
:doc:`/tutorial/manage-client-side-encryption-data-keys`.
277+
:ref:`Manage Data Encryption Keys <manual-manage-dek>`.
277278

278279
.. toctree::
279280
:titlesonly:
280281
:hidden:
281282

282-
/tutorial/manage-client-side-encryption-data-keys.txt
283+
/tutorial/manage-client-side-encryption-data-keys.txt

source/core/security-client-side-encryption.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _manual-csfle-feature:
2+
13
==================================
24
Client-Side Field Level Encryption
35
==================================
@@ -111,7 +113,7 @@ Explicit (manual) encryption of fields
111113
per-operation basis.
112114

113115
For more information, see
114-
:doc:`/core/security-explicit-client-side-encryption`.
116+
:ref:`Explicit (Manual) Client-Side Field Level Encryption <field-level-encryption-explicit>`.
115117

116118
Automatic encryption of fields
117119
.. include:: /includes/extracts/csfle-enterprise-atlas-only.rst
@@ -132,7 +134,7 @@ Automatic encryption of fields
132134
on automatic encryption rules.
133135

134136
For more information, see
135-
:doc:`/core/security-automatic-client-side-encryption`.
137+
:ref:`Automatic Client-Side Field Level Encryption <field-level-encryption-automatic>`.
136138

137139
MongoDB 4.2+ compatible drivers, :binary:`~bin.mongosh`, and the MongoDB
138140
4.2 or later legacy :binary:`~bin.mongo` shell automatically decrypt
@@ -309,7 +311,7 @@ Enforce Field Level Encryption Schema
309311
-------------------------------------
310312

311313
Starting with MongoDB 4.2, the server supports using
312-
:doc:`schema validation </core/schema-validation>` to enforce encryption
314+
:ref:`schema validation <schema-validation-overview>` to enforce encryption
313315
of specific fields in a collection. Use the
314316
:ref:`automatic encryption rule keywords
315317
<field-level-encryption-json-schema>` with the

source/core/security-explicit-client-side-encryption.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _field-level-encryption-explicit:
2+
13
====================================================
24
Explicit (Manual) Client-Side Field Level Encryption
35
====================================================
@@ -121,8 +123,9 @@ encryption:
121123
Server-Side Field Level Encryption Enforcement
122124
----------------------------------------------
123125

124-
The MongoDB 4.2 server supports using :doc:`schema validation
125-
</core/schema-validation>` to enforce encryption of specific fields in a
126+
The MongoDB 4.2 server supports using
127+
:ref:`schema validation <schema-validation-overview>`
128+
to enforce encryption of specific fields in a
126129
collection. If the collection validation :query:`$jsonSchema`
127130
requires encryption for a field, clients performing explicit (manual)
128131
field level encryption **must**

source/reference/method/KeyVault.addKeyAlternateName.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-addkeyaltname-method:
2+
13
==============================
24
KeyVault.addKeyAlternateName()
35
==============================

source/reference/method/KeyVault.createKey.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-createkey-method:
2+
13
====================
24
KeyVault.createKey()
35
====================

source/reference/method/KeyVault.deleteKey.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-deletekey-method:
2+
13
====================
24
KeyVault.deleteKey()
35
====================

source/reference/method/KeyVault.getKey.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-getkey-method:
2+
13
=================
24
KeyVault.getKey()
35
=================

source/reference/method/KeyVault.getKeyByAltName.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-getkeybyaltname-method:
2+
13
==========================
24
KeyVault.getKeyByAltName()
35
==========================

source/reference/method/KeyVault.getKeys.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _keyvault-getkeys-method:
2+
13
==================
24
KeyVault.getKeys()
35
==================

0 commit comments

Comments
 (0)