[deployment] improve breaking changes documentation #209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @helene-nguyen I did not add the deprecation/breaking changes for connectors. A mention in the table, a brief section with a short description and a link to a dedicated guide. cc @richard-julien @Kedae for awareness |
labo-flg
force-pushed
the
oob/improve-breaking-changes
branch
from
c09bdab
to
b9ea18f
Compare
|
@labo-flg We will have deprecation for 6.4 concerning stream connector splitting, I will add this |
|
I open for review so we start with this improved page and build on that. |
aHenryJard
reviewed
Oct 7, 2024
|
|
||
| Please note that the deprecated methods will be permanently removed in OpenCTI 6.5. | ||
| <a id="change-to-the-observable-promote-API"></a> |
There was a problem hiding this comment.
why do you need a a tag ? links are generated
There was a problem hiding this comment.
actually I've been copy-pasting how it's done elsewhere. Anchor links are not generated it seems.
aHenryJard
reviewed
Oct 7, 2024
aHenryJard
reviewed
Oct 7, 2024
labo-flg
commented
Nov 4, 2024
Comment on lines
37
to
40
|
|
||
| #### How to migrate | ||
|
|
||
| If you have issues after upgrade, you can try with both parameters set to `false`. |
There was a problem hiding this comment.
Suggested change
| #### How to migrate | |
| If you have issues after upgrade, you can try with both parameters set to `false`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking changes docs shall be improved to clarify our deprecation, our breaking changes and provide clear access to migration guides.