Skip to content
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

Reorganize 5.0 release notes #524

Merged
merged 7 commits into from
Feb 20, 2024

Conversation

stIncMale
Copy link
Member

@stIncMale stIncMale commented Feb 13, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-NNNNN
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/

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?
  • Are the facets and meta keywords accurate?

Sorry, something went wrong.

<https://mongodb.github.io/mongo-java-driver/4.11/apidocs/mongodb-driver-core/com/mongodb/connection/StreamFactory.html>`__

- Removes the following methods and types related to the
- Removes the following methods and types related to the
`Stream
<https://mongodb.github.io/mongo-java-driver/4.11/apidocs/mongodb-driver-core/com/mongodb/connection/Stream.html>`__
interface:
Copy link
Member Author

@stIncMale stIncMale Feb 13, 2024

Choose a reason for hiding this comment

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

This duplication probably happened as a result of (presumably) rebasing and manually resolving non-trivial conflicts in #513 after the review had been completed.

@stIncMale stIncMale force-pushed the 50_reorganize_release_notes branch from 5585f30 to f581f0f Compare February 13, 2024 21:58
@stIncMale
Copy link
Member Author

I can't check if formatting / links work properly as I don't know how to stage the changes.

stIncMale and others added 2 commits February 13, 2024 17:10
@stIncMale stIncMale requested a review from jyemin February 14, 2024 15:37
Copy link
Contributor

@rachel-mack rachel-mack left a comment

Choose a reason for hiding this comment

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

One change for consistency through the whole doc:

@@ -40,37 +40,65 @@ Learn what's new in:
What's New in 5.0
-----------------

.. warning:: Breaking Changes in v5.0
.. warning:: Breaking changes in this release
Copy link
Contributor

Choose a reason for hiding this comment

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

For consistency with the What's New sections for previous releases, this should be left as it is.

Suggested change
.. warning:: Breaking changes in this release
.. warning:: Breaking Changes in v5.0

Copy link
Member Author

@stIncMale stIncMale Feb 14, 2024

Choose a reason for hiding this comment

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

I see that the warning about deprecations in 4.11 (the latest release at the moment) uses the "Deprecations in this release" wording. This suggests that the wording was changed since release 4.8, where the wording is "Breaking Changes in v4.8". @rachel-mack Are you sure the old wording should be used again?

@stIncMale
Copy link
Member Author

@rachel-mack I haven't done any of the tasks in the "Self-Review Checklist", and the build is failing. Should someone from the docs team address all of that, or do you want this PR to be merged as is?

@stIncMale stIncMale merged commit 5cfe429 into mongodb:master Feb 20, 2024
@stIncMale stIncMale deleted the 50_reorganize_release_notes branch February 20, 2024 17:39
@docs-builder-bot
Copy link

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.

None yet

4 participants