Skip to content
This repository has been archived by the owner on Mar 11, 2022. It is now read-only.

Improve migration guide #469

Merged
merged 7 commits into from
Dec 21, 2021
Merged

Improve migration guide #469

merged 7 commits into from
Dec 21, 2021

Conversation

mojito317
Copy link
Contributor

@mojito317 mojito317 commented Dec 14, 2021

Checklist

  • Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
  • Added tests for code changes or test/build only changes
  • Updated the change log file (CHANGES.md|CHANGELOG.md) or test/build only changes
  • Completed the PR template below:

Description

Related to #450 and IBM/cloudant-node-sdk#410

My goal was to improve the migration guide dispersing the fog around the support of the retry feature ane error handling.

Approach

  • removed false sentence about the retry function 281404b
  • extended the line about plugins with the retry function 281404b and 65cb790
  • applied code style on the links for new operations 39fc65c
  • fixed incorrect links (dde9461):
    • postReplicate was excluded from new SDKs, so I pointed replicate()/replicateDb() to the putReplicationDocument operation
    • link for postChanges changed
  • for old AsStream functions I mentioned the new AsStream operation if available dde9461
  • Added a warning about the error handling c795cec

Schema & API Changes

  • "No change"

Security and Privacy

  • "No change"

Testing

  • N/A build or packaging only changes

Monitoring and Logging

  • "No change"

@emlaver emlaver self-requested a review December 15, 2021 14:47
Copy link
Member

@emlaver emlaver left a comment

Choose a reason for hiding this comment

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

Looks great!

@mojito317 mojito317 merged commit d68d7c2 into master Dec 21, 2021
@mojito317 mojito317 deleted the improve-migration-guide branch December 21, 2021 09:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants