Skip to content

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

Merged
merged 3 commits into from
May 12, 2023

Conversation

rustagir
Copy link
Collaborator

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

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a 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.

Comment on lines 47 to 48
- The driver now accurately detects Function-as-a-Service (FaaS)
environments in AWS.
Copy link
Contributor

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.

Comment on lines 49 to 50
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue:

  1. 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:

  1. Use "Queryable Encryption".

  2. 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."

Copy link
Collaborator Author

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

Copy link
Contributor

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.

@rustagir rustagir requested a review from ccho-mongodb May 12, 2023 20:18
Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment on lines +48 to +49
environments in AWS by considering AWS environment variables only if
they begin with ``AWS_Lambda_``.
Copy link
Contributor

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!

Comment on lines 49 to 50
- 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.
Copy link
Contributor

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.

@rustagir rustagir merged commit 5d7c5f9 into mongodb:master May 12, 2023
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
* DOCSP-29850: v5.5 release version updates

* add item to WN

* CC PR fixes 1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants