Skip to content

Commit 73f4fc2

Browse files
DOCSP-23292 QE Feedback Updates - Part 1 (#1301)
* testing banner add * implementing intro changes * adding line break to qe note * Changed technical preview to public preview * emdash * emdash * fixed formatting * wording * changed warning to tip * merge conflicts * feedback
1 parent 014d042 commit 73f4fc2

File tree

2 files changed

+45
-19
lines changed

2 files changed

+45
-19
lines changed

snooty.toml

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ title = "MongoDB Manual"
33

44
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
55

6-
intersphinx = [ "https://pymongo.readthedocs.io/en/stable/objects.inv",
7-
"https://motor.readthedocs.io/en/stable/objects.inv",
8-
"https://www.mongodb.com/docs/atlas/objects.inv",
9-
"https://www.mongodb.com/docs/php-library/upcoming/objects.inv",
10-
"https://www.mongodb.com/docs/compass/current/objects.inv",
11-
"https://www.mongodb.com/docs/database-tools/objects.inv",
12-
"https://www.mongodb.com/docs/mongodb-shell/objects.inv"
13-
]
6+
intersphinx = [
7+
"https://pymongo.readthedocs.io/en/stable/objects.inv",
8+
"https://motor.readthedocs.io/en/stable/objects.inv",
9+
"https://www.mongodb.com/docs/atlas/objects.inv",
10+
"https://www.mongodb.com/docs/php-library/upcoming/objects.inv",
11+
"https://www.mongodb.com/docs/compass/current/objects.inv",
12+
"https://www.mongodb.com/docs/database-tools/objects.inv",
13+
"https://www.mongodb.com/docs/mongodb-shell/objects.inv",
14+
]
1415

1516
# toc_landing_pages are pages that have pages nested beneath them
1617
# and **should** open when a user clicks on that page in the TOC
@@ -199,7 +200,7 @@ toc_landing_pages = [
199200
"/tutorial/manage-the-database-profiler",
200201
"/tutorial/query-documents",
201202
"/tutorial/remove-documents",
202-
"/tutorial/update-documents"
203+
"/tutorial/update-documents",
203204
]
204205

205206
[substitutions]
@@ -242,7 +243,7 @@ cmk-long = "Customer Master Key"
242243
cmk-abbr = ":abbr:`CMK ({+cmk-long+})`"
243244
dek-long = "Data Encryption Key"
244245
dek-abbr = ":abbr:`DEK ({+dek-long+})`"
245-
dek-abbr-no-hover= "DEK"
246+
dek-abbr-no-hover = "DEK"
246247
key-vault-long = "Key Vault collection"
247248
key-vault-long-title = "Key Vault Collection"
248249
java-driver-version = "4.6"
@@ -277,14 +278,26 @@ efm = "``encryptedFieldsMap``"
277278
targets = [
278279
"core/queryable-encryption.txt",
279280
"core/queryable-encryption/*.txt",
280-
"core/queryable-encryption/*/*.txt"
281+
"core/queryable-encryption/*/*.txt",
281282
]
282283

283284
variant = "danger"
284285
value = """
285-
Queryable Encryption is in Technical Preview and available for \
286-
evaluation purposes. Technical Preview is not recommended for \
287-
production deployments as breaking changes may be introduced.
286+
Queryable Encryption is in Public Preview and available for \
287+
evaluation purposes. Public Preview is not recommended for \
288+
production deployments as breaking changes may be introduced. \
289+
To learn more about the Preview please see the \
290+
`Queryable Encryption Preview <https://www.mongodb.com/blog/post/mongodb-releases-queryable-encryption-preview/>`__ \
291+
blog post.
292+
"""
293+
294+
[[banners]]
295+
targets = ["core/csfle.txt", "core/csfle/*.txt", "core/csfle/*/*.txt"]
296+
297+
variant = "tip"
298+
value = """
299+
The next-generation Queryable Encryption feature is now in Public Preview. \
300+
To learn more about Queryable Encryption, see :ref:`qe-manual-feature-qe`.
288301
"""
289302

290303
[bundle]

source/core/queryable-encryption.txt

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,24 @@
1515
Introduction
1616
------------
1717

18-
{+qe+} is a feature that enables you to encrypt data in your
19-
application before you send it over the network to MongoDB while still
20-
maintaining the ability to query the encrypted data. With {+qe+}
21-
enabled, no MongoDB-managed service has access to your data in an
22-
unencrypted form.
18+
{+qe+} gives you the ability to perform the following tasks:
19+
20+
- Encrypt sensitive data fields from the client-side.
21+
- Store sensitive data fields as fully randomized encrypted data on the database
22+
server-side.
23+
- Run expressive queries on the encrypted data.
24+
25+
These tasks are all completed without the server having knowledge of the data
26+
it's processing.
27+
28+
Sensitive data is encrypted throughout its lifecycle - in-transit, at-rest, in-use,
29+
in logs, and backups - and only ever decrypted on the client-side, since only you
30+
have access to the encryption keys.
31+
32+
{+qe+} introduces an industry-first fast, searchable encryption
33+
scheme developed by the pioneers in encrypted search. The feature supports equality
34+
searches, with additional query types such as range, prefix, suffix, and substring
35+
planned for future releases.
2336

2437
You can set up {+qe+} using the following mechanisms:
2538

0 commit comments

Comments
 (0)