DOCSP-45586: Remove What's New breaking changes #80
Conversation
✅ Deploy Preview for docs-cpp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -66,12 +66,64 @@ and upgrade versions. | |||
| If you're upgrading the {+driver-short+} from version 3.0 to version 3.10, | |||
| address all breaking changes listed for versions 3.1 to 3.10, if any. | |||
|
|
|||
| Types of Breaking Changes | |||
There was a problem hiding this comment.
Question/Suggestion: should we change the .. contents:: component to be depth level 2? Each of the main headers have a few subsections so might be helpful to include those in the page ToC. If changing this results in the ToC becoming too lengthy/unwieldy, feel free to leave
There was a problem hiding this comment.
I changed depth to 2 originally, but it did make the TOC look overly complicated (since the subheaders have long titles). So I think I'll leave as is
There was a problem hiding this comment.
nvm changed back to 2 after restructuring!
There was a problem hiding this comment.
Possibly related (I do not fully understand the depth level discussion), I am in favor of removing the "Breaking Change Definition" and "Types of Breaking Changes" headers entirely while preserving the remaining content as-is, such that the current contents of each section just become contents of "Overview".
On this page
- Overview
- Breaking Changes
- Version 4.0
- ...
There was a problem hiding this comment.
Hm, Overview gets pretty long and disorganized if I remove those subheaders.
There was a problem hiding this comment.
If so, I am fine with leaving them as-is.
| @@ -66,12 +66,64 @@ and upgrade versions. | |||
| If you're upgrading the {+driver-short+} from version 3.0 to version 3.10, | |||
| address all breaking changes listed for versions 3.1 to 3.10, if any. | |||
|
|
|||
| Types of Breaking Changes | |||
There was a problem hiding this comment.
Possibly related (I do not fully understand the depth level discussion), I am in favor of removing the "Breaking Change Definition" and "Types of Breaking Changes" headers entirely while preserving the remaining content as-is, such that the current contents of each section just become contents of "Overview".
On this page
- Overview
- Breaking Changes
- Version 4.0
- ...
| @@ -66,12 +66,64 @@ and upgrade versions. | |||
| If you're upgrading the {+driver-short+} from version 3.0 to version 3.10, | |||
| address all breaking changes listed for versions 3.1 to 3.10, if any. | |||
|
|
|||
| Types of Breaking Changes | |||
There was a problem hiding this comment.
If so, I am fine with leaving them as-is.
Pull Request Info
PR Reviewing Guidelines
This PR removes repeated breaking change information by taking them out of What's New. It should be merged before the 4.0 release tickets.
JIRA - https://jira.mongodb.org/browse/DOCSP-45586
Staging:
https://deploy-preview-80--docs-cpp.netlify.app/whats-new/
https://deploy-preview-80--docs-cpp.netlify.app/upgrade/
Self-Review Checklist