Rusoto: Time to remove migration notes from README?

[matthewkmayer]

The main README file has information on migrating to Rusoto 0.25.0 or later. I've made issues in all repos for crates using the outdated mega-crate of Rusoto 0.24 or earlier.

Is it time to remove that bit from the README? Reducing the noise in the README will help new users of Rusoto.

Perhaps it could be added to https://rusoto.org as a page.

[srijs]

If there's still value in having these migration guides around, could it be worth moving them into a separate markdown document (UPGRADING.md seems to be commonly used) and just linking to that from the main README?

(or yeah, as you say, move them into the gitbook)

I do agree on the main point that we should move them out of the main README to reduce noise!

[srijs]

Just making a quick note here that we shouldn't forget to add a migration guide to 0.32.0 which covers how to migrate a codebase to the new sync API.

[matthewkmayer]

Any chance you can write the 0.31 to 0.32 migration guide, @srijs ? The documentation work keeps slipping down my list of things to do. 😢 Otherwise I can migrate one of my open source projects to async Rusoto and record my notes.

[dovahcrow]

Currently, if someone wants to just use 0.32 rusoto but has no time to migrate to tokio stack, a quick (but dirty) way is using XXXClient::simple(Region) to create a client, and instead of original xxclient.operation()?, one can use xxxclient.operation().wait()? for quick fix. As for stream data, like s3 file body, use s3client.get_object().concat2().wait()? instead.

[srijs]

No worries, I’m happy to sign up for that!

I’d probs wait until we land timeout support though, as that might change the API a bit again.

[matthewkmayer]

https://github.com/rusoto/rusoto.github.io/pull/79 has both the 0.24 to 0.25 notes and a guide for the current async API, marked as a pre-release thus subject to change. 😄