Skip to content

Commit 51fd765

Browse files
biniona-mongodbbiniona-mongodb
authored
encrypted document -> document with encrypted fields (#2065)
1 parent df5f9cf commit 51fd765

File tree

35 files changed

+160
-157
lines changed

35 files changed

+160
-157
lines changed

‎snooty.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,9 @@ windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE04
240240
source-available = ":github:`source available and free to use <mongodb/mongo>`"
241241
csfle = "Client-Side Field Level Encryption"
242242
csfle-abbrev = "CSFLE"
243+
in-use-doc = "document with encrypted fields"
244+
in-use-doc-title = "Document with Encrypted Fields"
245+
in-use-docs = "documents with encrypted fields"
243246
kms-long = "Key Management System"
244247
kms-abbr = ":abbr:`KMS ({+kms-long+})`"
245248
km-service-long = "Key Management Service"

‎source/core/csfle/quick-start.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -187,34 +187,34 @@ Procedure
187187
.. tab::
188188
:tabid: java-sync
189189

190-
To view the complete code for inserting an encrypted document, see
190+
To view the complete code for inserting a {+in-use-doc+}, see
191191
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
192192

193193
.. tab::
194194
:tabid: nodejs
195195

196-
To view the complete code for inserting an encrypted document, see
196+
To view the complete code for inserting a {+in-use-doc+}, see
197197
`our Github repository <{+sample-app-url-csfle+}/node/local/reader/insert_encrypted_document.js>`__.
198198

199199
.. tab::
200200
:tabid: python
201201

202-
To view the complete code for inserting an encrypted document, see
202+
To view the complete code for inserting a {+in-use-doc+}, see
203203
`our Github repository <{+sample-app-url-csfle+}/python/local/reader/insert_encrypted_document.py>`__.
204204

205205
.. tab::
206206
:tabid: csharp
207207

208-
To view the complete code for inserting an encrypted document, see
208+
To view the complete code for inserting a {+in-use-doc+}, see
209209
`our Github repository <{+sample-app-url-csfle+}/dotnet/local/reader/CSFLE/InsertEncryptedDocument.cs>`__
210210

211211
.. tab::
212212
:tabid: go
213213

214-
To view the complete code for inserting an encrypted document, see
214+
To view the complete code for inserting a {+in-use-doc+}, see
215215
`our Github repository <{+sample-app-url-csfle+}/go/local/reader/insert-encrypted-document.go>`__.
216216

217-
.. step:: Retrieve Your Encrypted Document
217+
.. step:: Retrieve Your {+in-use-doc-title+}
218218

219219
.. include:: /includes/quick-start/find.rst
220220

@@ -225,31 +225,31 @@ Procedure
225225
.. tab::
226226
:tabid: java-sync
227227

228-
To view the complete code for finding an encrypted document, see
228+
To view the complete code for finding a {+in-use-doc+}, see
229229
`our Github repository <{+sample-app-url-csfle+}/java/local/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
230230

231231
.. tab::
232232
:tabid: nodejs
233233

234-
To view the complete code for finding an encrypted document, see
234+
To view the complete code for finding a {+in-use-doc+}, see
235235
`our Github repository <{+sample-app-url-csfle+}/node/local/reader/insert_encrypted_document.js>`__.
236236

237237
.. tab::
238238
:tabid: python
239239

240-
To view the complete code for finding an encrypted document, see
240+
To view the complete code for finding a {+in-use-doc+}, see
241241
`our Github repository <{+sample-app-url-csfle+}/python/local/reader/insert_encrypted_document.py>`__.
242242

243243
.. tab::
244244
:tabid: csharp
245245

246-
To view the complete code for finding an encrypted document, see
246+
To view the complete code for finding a {+in-use-doc+}, see
247247
`our Github repository <{+sample-app-url-csfle+}/dotnet/local/reader/CSFLE/InsertEncryptedDocument.cs>`__
248248

249249
.. tab::
250250
:tabid: go
251251

252-
To view the complete code for finding an encrypted document, see
252+
To view the complete code for finding a {+in-use-doc+}, see
253253
`our Github repository <{+sample-app-url-csfle+}/go/local/reader/insert-encrypted-document.go>`__.
254254

255255

‎source/core/csfle/tutorials/aws/aws-automatic.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ application using Amazon Web Services (AWS) {+kms-abbr+}.
2222
After you complete the steps in this guide, you should have:
2323

2424
- A {+cmk-long+} hosted on an AWS KMS instance.
25-
- A working client application that inserts encrypted documents
25+
- A working client application that inserts {+in-use-docs+}
2626
using your {+cmk-long+}.
2727

2828
Before You Get Started
@@ -148,34 +148,34 @@ Create the Application
148148
.. tab::
149149
:tabid: java-sync
150150

151-
To view the complete code for inserting an encrypted document, see
151+
To view the complete code for inserting a {+in-use-doc+}, see
152152
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
153153

154154
.. tab::
155155
:tabid: nodejs
156156

157-
To view the complete code for inserting an encrypted document, see
157+
To view the complete code for inserting a {+in-use-doc+}, see
158158
`our Github repository <{+sample-app-url-csfle+}/node/aws/reader/insert_encrypted_document.js>`__.
159159

160160
.. tab::
161161
:tabid: python
162162

163-
To view the complete code for inserting an encrypted document, see
163+
To view the complete code for inserting a {+in-use-doc+}, see
164164
`our Github repository <{+sample-app-url-csfle+}/python/aws/reader/insert_encrypted_document.py>`__.
165165

166166
.. tab::
167167
:tabid: csharp
168168

169-
To view the complete code for inserting an encrypted document, see
169+
To view the complete code for inserting a {+in-use-doc+}, see
170170
`our Github repository <{+sample-app-url-csfle+}/dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs>`__
171171

172172
.. tab::
173173
:tabid: go
174174

175-
To view the complete code for inserting an encrypted document, see
175+
To view the complete code for inserting a {+in-use-doc+}, see
176176
`our Github repository <{+sample-app-url-csfle+}/go/aws/reader/insert-encrypted-document.go>`__.
177177

178-
.. step:: Retrieve Your Encrypted Document
178+
.. step:: Retrieve Your {+in-use-doc-title+}
179179

180180
.. include:: /includes/tutorials/automatic/aws/find.rst
181181

@@ -186,31 +186,31 @@ Create the Application
186186
.. tab::
187187
:tabid: java-sync
188188

189-
To view the complete code for finding an encrypted document, see
189+
To view the complete code for finding a {+in-use-doc+}, see
190190
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
191191

192192
.. tab::
193193
:tabid: nodejs
194194

195-
To view the complete code for finding an encrypted document, see
195+
To view the complete code for finding a {+in-use-doc+}, see
196196
`our Github repository <{+sample-app-url-csfle+}/node/aws/reader/insert_encrypted_document.js>`__.
197197

198198
.. tab::
199199
:tabid: python
200200

201-
To view the complete code for finding an encrypted document, see
201+
To view the complete code for finding a {+in-use-doc+}, see
202202
`our Github repository <{+sample-app-url-csfle+}/python/aws/reader/insert_encrypted_document.py>`__.
203203

204204
.. tab::
205205
:tabid: csharp
206206

207-
To view the complete code for finding an encrypted document, see
207+
To view the complete code for finding a {+in-use-doc+}, see
208208
`our Github repository <{+sample-app-url-csfle+}/dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs>`__
209209

210210
.. tab::
211211
:tabid: go
212212

213-
To view the complete code for finding an encrypted document, see
213+
To view the complete code for finding a {+in-use-doc+}, see
214214
`our Github repository <{+sample-app-url-csfle+}/go/aws/reader/insert-encrypted-document.go>`__.
215215

216216

‎source/core/csfle/tutorials/azure/azure-automatic.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ application using {+azure-kv+}.
2121
After you complete the steps in this guide, you should have:
2222

2323
- A {+cmk-long+} hosted on an {+azure-kv+} instance.
24-
- A working client application that inserts encrypted documents
24+
- A working client application that inserts {+in-use-docs+}
2525
using your {+cmk-long+}.
2626

2727
Before You Get Started
@@ -146,34 +146,34 @@ Create the Application
146146
.. tab::
147147
:tabid: java-sync
148148

149-
To view the complete code for inserting an encrypted document, see
149+
To view the complete code for inserting a {+in-use-doc+}, see
150150
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
151151

152152
.. tab::
153153
:tabid: nodejs
154154

155-
To view the complete code for inserting an encrypted document, see
155+
To view the complete code for inserting a {+in-use-doc+}, see
156156
`our Github repository <{+sample-app-url-csfle+}/node/azure/reader/insert_encrypted_document.js>`__.
157157

158158
.. tab::
159159
:tabid: python
160160

161-
To view the complete code for inserting an encrypted document, see
161+
To view the complete code for inserting a {+in-use-doc+}, see
162162
`our Github repository <{+sample-app-url-csfle+}/python/azure/reader/insert_encrypted_document.py>`__.
163163

164164
.. tab::
165165
:tabid: csharp
166166

167-
To view the complete code for inserting an encrypted document, see
167+
To view the complete code for inserting a {+in-use-doc+}, see
168168
`our Github repository <{+sample-app-url-csfle+}/dotnet/azure/reader/CSFLE/InsertEncryptedDocument.cs>`__
169169

170170
.. tab::
171171
:tabid: go
172172

173-
To view the complete code for inserting an encrypted document, see
173+
To view the complete code for inserting a {+in-use-doc+}, see
174174
`our Github repository <{+sample-app-url-csfle+}/go/azure/reader/insert-encrypted-document.go>`__.
175175

176-
.. step:: Retrieve Your Encrypted Document
176+
.. step:: Retrieve Your {+in-use-doc-title+}
177177

178178
.. include:: /includes/tutorials/automatic/azure/find.rst
179179

@@ -184,31 +184,31 @@ Create the Application
184184
.. tab::
185185
:tabid: java-sync
186186

187-
To view the complete code for finding an encrypted document, see
187+
To view the complete code for finding a {+in-use-doc+}, see
188188
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
189189

190190
.. tab::
191191
:tabid: nodejs
192192

193-
To view the complete code for finding an encrypted document, see
193+
To view the complete code for finding a {+in-use-doc+}, see
194194
`our Github repository <{+sample-app-url-csfle+}/node/azure/reader/insert_encrypted_document.js>`__.
195195

196196
.. tab::
197197
:tabid: python
198198

199-
To view the complete code for finding an encrypted document, see
199+
To view the complete code for finding a {+in-use-doc+}, see
200200
`our Github repository <{+sample-app-url-csfle+}/python/azure/reader/insert_encrypted_document.py>`__.
201201

202202
.. tab::
203203
:tabid: csharp
204204

205-
To view the complete code for finding an encrypted document, see
205+
To view the complete code for finding a {+in-use-doc+}, see
206206
`our Github repository <{+sample-app-url-csfle+}/dotnet/azure/reader/CSFLE/InsertEncryptedDocument.cs>`__
207207

208208
.. tab::
209209
:tabid: go
210210

211-
To view the complete code for finding an encrypted document, see
211+
To view the complete code for finding a {+in-use-doc+}, see
212212
`our Github repository <{+sample-app-url-csfle+}/go/azure/reader/insert-encrypted-document.go>`__.
213213

214214

‎source/core/csfle/tutorials/gcp/gcp-automatic.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ application using Google Cloud Key Management Service.
2121
After you complete the steps in this guide, you should have:
2222

2323
- A {+cmk-abbr+} hosted on Google Cloud Key Management Service.
24-
- A client application that inserts encrypted documents using your {+cmk-abbr+}.
24+
- A client application that inserts {+in-use-docs+} using your {+cmk-abbr+}.
2525

2626
Before You Get Started
2727
----------------------
@@ -149,34 +149,34 @@ your application to see relevant code samples.
149149
.. tab::
150150
:tabid: java-sync
151151

152-
To view the complete code for inserting an encrypted document, see
152+
To view the complete code for inserting a {+in-use-doc+}, see
153153
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
154154

155155
.. tab::
156156
:tabid: nodejs
157157

158-
To view the complete code for inserting an encrypted document, see
158+
To view the complete code for inserting a {+in-use-doc+}, see
159159
`our Github repository <{+sample-app-url-csfle+}/node/gcp/reader/insert_encrypted_document.js>`__.
160160

161161
.. tab::
162162
:tabid: python
163163

164-
To view the complete code for inserting an encrypted document, see
164+
To view the complete code for inserting a {+in-use-doc+}, see
165165
`our Github repository <{+sample-app-url-csfle+}/python/gcp/reader/insert_encrypted_document.py>`__.
166166

167167
.. tab::
168168
:tabid: csharp
169169

170-
To view the complete code for inserting an encrypted document, see
170+
To view the complete code for inserting a {+in-use-doc+}, see
171171
`our Github repository <{+sample-app-url-csfle+}/dotnet/gcp/reader/CSFLE/InsertEncryptedDocument.cs>`__
172172

173173
.. tab::
174174
:tabid: go
175175

176-
To view the complete code for inserting an encrypted document, see
176+
To view the complete code for inserting a {+in-use-doc+}, see
177177
`our Github repository <{+sample-app-url-csfle+}/go/gcp/reader/insert-encrypted-document.go>`__.
178178

179-
.. step:: Retrieve Your Encrypted Document
179+
.. step:: Retrieve Your {+in-use-doc-title+}
180180

181181
.. include:: /includes/tutorials/automatic/gcp/find.rst
182182

@@ -187,31 +187,31 @@ your application to see relevant code samples.
187187
.. tab::
188188
:tabid: java-sync
189189

190-
To view the complete code for finding an encrypted document, see
190+
To view the complete code for finding a {+in-use-doc+}, see
191191
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
192192

193193
.. tab::
194194
:tabid: nodejs
195195

196-
To view the complete code for finding an encrypted document, see
196+
To view the complete code for finding a {+in-use-doc+}, see
197197
`our Github repository <{+sample-app-url-csfle+}/node/gcp/reader/insert_encrypted_document.js>`__.
198198

199199
.. tab::
200200
:tabid: python
201201

202-
To view the complete code for finding an encrypted document, see
202+
To view the complete code for finding a {+in-use-doc+}, see
203203
`our Github repository <{+sample-app-url-csfle+}/python/gcp/reader/insert_encrypted_document.py>`__.
204204

205205
.. tab::
206206
:tabid: csharp
207207

208-
To view the complete code for finding an encrypted document, see
208+
To view the complete code for finding a {+in-use-doc+}, see
209209
`our Github repository <{+sample-app-url-csfle+}/dotnet/gcp/reader/CSFLE/InsertEncryptedDocument.cs>`__
210210

211211
.. tab::
212212
:tabid: go
213213

214-
To view the complete code for finding an encrypted document, see
214+
To view the complete code for finding a {+in-use-doc+}, see
215215
`our Github repository <{+sample-app-url-csfle+}/go/gcp/reader/insert-encrypted-document.go>`__.
216216

217217

0 commit comments

Comments
 (0)