[DOCS-14648] CSFLE: Make code sample templates more clear that a substitution is needed Created: 15/Jul/21  Updated: 04/Jan/23  Resolved: 01/Sep/21

Status: Closed
Project: Documentation
Component/s: drivers
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Minor - P4
Reporter: Dmitry Ryabtsev Assignee: Kailie Yuan
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 2 years, 23 weeks, 1 day ago
Story Points: 2

 Description   

In the following article it was found that some users fail to correctly substitute values in the code sample templates. For example:

// We have 
providerDetails.put("privateKey", new BsonString("<GCP service account private key>"));
// User used
providerDetails.put("privateKey", new BsonString("<GCP $privateKey>"));
// Instead of
providerDetails.put("privateKey", new BsonString("$privateKey"));

Can we consider make it more clear what sort of substitution is needed?



 Comments   
Comment by Githook User [ 31/Aug/21 ]

Author:

{'name': 'kyuan-mongodb', 'email': '78768401+kyuan-mongodb@users.noreply.github.com', 'username': 'kyuan-mongodb'}

Message: DOCS-14648 CSFLE template clarification (#757)

Comment by Kailie Yuan [ 30/Aug/21 ]

https://github.com/mongodb/docs-ecosystem/pull/757

Generated at Thu Feb 08 08:10:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.