-
Notifications
You must be signed in to change notification settings - Fork 51
DOCSP-29850: v5.5 release version updates #682
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting to these updates quickly! I think that the What's New items need to be more detailed so that users are confident they understand the changes in the new version.
source/whats-new.txt
Outdated
- The driver now accurately detects Function-as-a-Service (FaaS) | ||
environments in AWS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue:
This seems like it fixes a bug, but that bug hasn't clearly been described. From reading this, I'm not sure what it means to more accurately detect a FaaS environment in AWS.
Suggestion:
Provide more detail on what the behavior was previously and what it more accurately detects.
source/whats-new.txt
Outdated
- You must upgrade ``mongodb-client-encryption`` to version 2.8.0 or | ||
later if you want to create a QE collection while using this driver version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue:
- As recommended by the style guide, explain the terms before using abbreviations.
2 I think) QE collection is not the official name for encrypted collection; instead, use "encrypted collection" as referred to on this page.
Suggestion:
-
Use "Queryable Encryption".
-
Use "encrypted collection" as it is referred to on this page.
Both suggestions incorporated:
"You must use ... v2.8.0 or later to encrypt collections by using the Queryable Encryption feature."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the "in this this driver version" is implicit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the "in this this driver version" is implicit
I agree, and thanks for catching the mistake in my suggestion.
I think there is also nuance here in which omitting the driver version is important. From what I know so far, the previous version of the driver won't be able to create encrypted collections when using older versions of mongodb-client-encryption either as that functionality will be removed from the server too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
environments in AWS by considering AWS environment variables only if | ||
they begin with ``AWS_Lambda_``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to know, thanks for clarifying this!
source/whats-new.txt
Outdated
- You must upgrade ``mongodb-client-encryption`` to version 2.8.0 or | ||
later if you want to create a QE collection while using this driver version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the "in this this driver version" is implicit
I agree, and thanks for catching the mistake in my suggestion.
I think there is also nuance here in which omitting the driver version is important. From what I know so far, the previous version of the driver won't be able to create encrypted collections when using older versions of mongodb-client-encryption either as that functionality will be removed from the server too.
* DOCSP-29850: v5.5 release version updates * add item to WN * CC PR fixes 1
Pull Request Info
PR Reviewing Guidelines
JIRA - DOCSP-29850
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-29850-v5.5-release/
compat
whats new
Self-Review Checklist