DRIVERS-2789 Convert CSE Spec to Markdown #1527

blink1073 · 2024-02-27T12:35:09Z

Please complete the following before merging:

Update changelog.
Make sure there are generated JSON files from the YAML test files.
Test changes in at least one language driver.
Test these changes against all server versions and topologies (including standalone, replica set, sharded
clusters, and serverless).

…t-side-encryption/tests/README.md

…lient-side-encryption/tests/benchmarks.md

…urce/client-side-encryption/client-side-encryption.md

jmikola

I'll review again once you take a pass through the generated heading links. Also, you should probably replace @dariakp with another reviewer.

source/unified-test-format/unified-test-format.md

source/unified-test-format/unified-test-format.rst

source/unified-test-format/unified-test-format.md

source/unified-test-format/unified-test-format.rst

source/client-side-encryption/client-side-encryption.md

jmikola · 2024-02-27T17:06:26Z

source/client-side-encryption/client-side-encryption.md

+See also:
+
+> - [Introduction on crypt_shared](#crypt_shared)
+> - \[Enabling crypt_shared\](#Enabling crypt_shared)


The "Enabling crypt_shared" links are broken throughout this document.

Also, the block-quoting probably isn't necessary here.

This still appears outstanding.

source/client-side-encryption/client-side-encryption.md

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

blink1073 · 2024-02-28T22:13:19Z

I addressed some but not all comments, stopping here for today.

blink1073 · 2024-03-01T00:54:32Z

I believe I've addressed all review.

jmikola

Feel free to take whatever suggestions you want. I don't think I need to come back and look through this a fourth time.

jmikola · 2024-03-01T16:08:03Z

.gitignore

@@ -10,3 +10,4 @@ logo.png
 codereview.rc
 .idea/**
 docs_build
+.pytest_cache


do you want to add a trailing newline?

jmikola · 2024-03-01T16:09:17Z

source/client-side-encryption/tests/README.md

+- Addition of `\$db` to command in `command_started_event`
+- Addition of `\$\$type` to command_started_event and outcome.


These dollar signs should not be escaped. Also applies to some content later in the file.

jmikola · 2024-03-01T16:10:25Z

source/client-side-encryption/tests/README.md

+should ensure that `crypt_shared` will not be loaded. Refer to the client-side-encryption documentation for information
+on "disabling" `crypt_shared` and setting library search paths.
+
+> \[!NOTE\] The [crypt_shared](../client-side-encryption.rst#crypt_shared) dynamic library can be obtained using the


Unnecessary escaping for the "NOTE" element. Also applies later in the file.

jmikola · 2024-03-01T16:13:29Z

source/client-side-encryption/client-side-encryption.md

+
+KMS providers
+
+> A map of KMS providers to credentials. Configured client-side. Example:


Is the blockquote intentional here?

An alternative approach to formatting the terminology lists would be to apply bold formatting to the leading terms and/or use a bulleted list. Doing both would probably be best for readability.

jmikola · 2024-03-01T16:15:23Z

source/client-side-encryption/client-side-encryption.md

+
+[crypt_shared](#crypt_shared) is a dynamically-loaded C++ library providing query analysis for auto-encryption. It
+replaces [mongocryptd](#mongocryptd) for performing query analysis to -
+Ref:`mark-up sensitive fields within a command <subtype6.intent-to-encrypt>`.


"- Ref:`mark-up..." looks like an artifact.

source/client-side-encryption/client-side-encryption.md

…de-encryption/subtype6.md

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

…ons into DRIVERS-2789-cse-2

blink1073 · 2024-03-04T12:45:02Z

Thanks for the review both! As suggested, let's merge and iterate.

blink1073 added 5 commits February 27, 2024 06:23

Rename source/client-side-encryption/tests/README.rst to source/clien…

3b3c3cf

…t-side-encryption/tests/README.md

Rename source/client-side-encryption/tests/benchmarks.rst to source/c…

3e8a63e

…lient-side-encryption/tests/benchmarks.md

Rename source/client-side-encryption/client-side-encryption.rst to so…

c14504c

…urce/client-side-encryption/client-side-encryption.md

DRIVERS-2789 Convert CSE Spec to Markdown

b133dd0

remove test readmes

33c3229

blink1073 requested review from a team as code owners February 27, 2024 12:35

blink1073 requested review from jmikola, tom-selander and dariakp and removed request for a team, jmikola, tom-selander and dariakp February 27, 2024 12:35

remove toc for test plan

80f0109

jmikola reviewed Feb 27, 2024

View reviewed changes

blink1073 and others added 6 commits February 27, 2024 11:24

Update source/unified-test-format/unified-test-format.md

1b760bd

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/unified-test-format/unified-test-format.rst

4906820

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/unified-test-format/unified-test-format.md

f9bdf2d

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/unified-test-format/unified-test-format.rst

9a39545

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

f6f4a39

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

e6d1a42

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

blink1073 requested a review from kevinAlbs February 27, 2024 17:25

fix anchor links

18e7c56

blink1073 added 3 commits February 28, 2024 15:49

fix admonition

c2b3ee1

try with admon plugin

abb4f57

address review

1c18dd7

blink1073 added 3 commits February 28, 2024 17:37

try with mdformat-wikilinks plugin

093dae2

remove mdformat-wikilink plugin

97dcd56

address review

e0313d8

blink1073 requested a review from jmikola March 1, 2024 00:54

jmikola approved these changes Mar 1, 2024

View reviewed changes

blink1073 and others added 17 commits March 4, 2024 06:28

Rename source/client-side-encryption/subtype6.rst to source/client-si…

d445d2a

…de-encryption/subtype6.md

Update source/client-side-encryption/client-side-encryption.md

e6cdce8

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

e56cad9

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

e45fd89

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

54499a9

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

e4bd1a6

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

20f6a1e

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

06bd847

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

a45f4b5

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

940008b

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

9e6a69d

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

70d8373

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

5bf803f

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

Update source/client-side-encryption/client-side-encryption.md

c1a7104

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

address review

fdd87b8

Merge branch 'DRIVERS-2789-cse-2' of github.com:blink1073/specificati…

b1a4abb

…ons into DRIVERS-2789-cse-2

one more link fix

c57ec63

blink1073 merged commit fc360b2 into mongodb:master Mar 4, 2024
4 checks passed

blink1073 deleted the DRIVERS-2789-cse-2 branch March 4, 2024 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DRIVERS-2789 Convert CSE Spec to Markdown #1527

DRIVERS-2789 Convert CSE Spec to Markdown #1527

blink1073 commented Feb 27, 2024

jmikola left a comment •

edited

Loading

jmikola Feb 27, 2024

blink1073 Feb 27, 2024

jmikola Feb 28, 2024

blink1073 Mar 4, 2024

blink1073 commented Feb 28, 2024

blink1073 commented Mar 1, 2024

jmikola left a comment •

edited

Loading

jmikola Mar 1, 2024

jmikola Mar 1, 2024

jmikola Mar 1, 2024

jmikola Mar 1, 2024

jmikola Mar 1, 2024

blink1073 commented Mar 4, 2024

		- Addition of `\$db` to command in `command_started_event`
		- Addition of `\$\$type` to command_started_event and outcome.


		KMS providers

		> A map of KMS providers to credentials. Configured client-side. Example:

DRIVERS-2789 Convert CSE Spec to Markdown #1527

DRIVERS-2789 Convert CSE Spec to Markdown #1527

Conversation

blink1073 commented Feb 27, 2024

jmikola left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blink1073 commented Feb 28, 2024

blink1073 commented Mar 1, 2024

jmikola left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blink1073 commented Mar 4, 2024

jmikola left a comment •

edited

Loading

jmikola left a comment •

edited

Loading