[CDRIVER-4483] CSFLE/QE Naming Created: 04/Oct/22  Updated: 28/Oct/23  Resolved: 04/May/23

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.24.0

Type: Task Priority: Unknown
Reporter: PM Bot Assignee: Kevin Albertson
Resolution: Fixed Votes: 0
Labels: neweng
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split from DRIVERS-2454 CSFLE/QE Naming Implementing
Related
Quarter: FY24Q2
Upstream Changes Summary:

DRIVERS-2454:
There is a distinct difference between Queryable Encryption and Client-Side Field Level Encryption made in the Server docs. Drivers must update their docs to reflect correct terminology as-needed.

Both features CSFLE and QE are nested under "In Use Encryption" rather than "Client Side Encryption".  Please verify and rename any documents to follow this convention.

If applicable, open a docs ticket for this effort.


 Description   

This ticket was split from DRIVERS-2454, please see that ticket for a detailed description.



 Comments   
Comment by Githook User [ 04/May/23 ]

Author:

{'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}

Message: CDRIVER-4483 add docs page for "In-Use Encryption" (#1255)

  • use IUE in docstring of ENABLE_CLIENT_SIDE_ENCRYPTION
  • use IUE in error reporting docs
  • add IUE page
  • rename using_client_side_encryption to client-side-field-level-encryption
  • replace "Client-Side Encryption" with CSFLE

For consistency with MongoDB Manual

  • remove Installation from CSFLE page

It is moved to IUE page

  • remove notes of mongocryptd from CSFLE docs

Use of mongocryptd is documented in IUE page

  • replace spec link with manual links in `*_opts_set_extra`
  • replace links of client-side-encryption to in-use-encryption
  • use IUE in `*_enable_auto_encryption`
  • use IUE links instead of CSFLE links

For documentation that applies to both CSFLE and QE

  • use QE links for API only applicable to QE
  • remove orphan directive

QE page is now in Table-Of-Contents of IUE page

  • add QE MongoDB Manual links
  • replace spec links with MongoDB Manual

MongoDB Manual is intended for users. Specifications are intended for driver developers.

  • remove unused :man-page:

The intended text is :man_page:. The page was not generated.
Adding CSFLE examples to man pages may not be necessary.

  • note API specific to IUE and QE
  • add Manual links to QE and CSFLE pages
  • consistently refer to "automatic encryption"
  • link to Query Analysis
Generated at Wed Feb 07 21:21:02 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.