-
Notifications
You must be signed in to change notification settings - Fork 552
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
docs: cosmoscmd
migration
#2949
Conversation
Thanks for tackling this Alex! I generated a chain with 0.24 and tried to apply the migration guide, it went smoothly, just sometimes I had a hard time to find where the diffs are. Since I wrote this code migration, it can possibly be even harder for a user I assume ^^'. That's why I checked the docusaurus documentation and found this awesome Since I applied the migration on a chain, I can just run Finally, icing on the cake, it's also possible to add custom magic comments (this is how those instructions are called in docusaurus, see related docs). We can add a custom one to specify that a line as been removed. Typically something that renders like that : Tell me if you're interested, I have locally some docusaurus config changes for that. |
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Thomas Bruyelle <[email protected]>
Visit the preview URL for this PR (updated for commit cb37ad5): https://ignitesrvc-d--pr2949-docs-cosmoscmd-migra-5kh52m2o.web.app (expires Wed, 09 Nov 2022 17:39:21 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 60382552e86c69890c026e09478220ea153394a8 |
Incredible @tbruyelle, thank you ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please kindly review the comments, thanks
This changes are based in a SDK v0.45.x or v0.46.x ? For the second I guess |
@tbruyelle some help with docusaurus config would be great! |
Yes, the latest version of |
Sure, do you want to add a custom magic comment to highlight removed lines ? |
Yes please 👍 |
It's there 5a3aa9a I added one magic comment as an example, you need to add the others :) |
@tbruyelle thanks for all of the help. Changes made here |
@aljo242 I see 2 other things we may address in the 0.25 migration : Wdyt ? The changes concern the |
Sorry I couldn't stop myself from adding more magic comments :P 6b327ea |
Yes, we should add these as well - great catch! I would really appreciate it if you added. You're a docs legend |
@aljo242 I added 2 new sections for each issues, please review :) |
since it's already present in migration v0.25.0
Also: - reorg migration guides between v0.25.1 and v0.25.0 - fix broken yaml in markdown headers
Amazing! merging! |
* start guide * remaining changes * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * Update docs/docs/migration/v0.25.0.md Co-authored-by: Thomas Bruyelle <[email protected]> * highlight and update version * add highlight magic comments * Update docs/docs/migration/v0.25.0.md Co-authored-by: Jerónimo Albi <[email protected]> * rename * address feedback * add custom docusaurus magic-comment to highlight removed lines * remaining fixes * docs: broader usage of remove-next-line magic comment * docs: add migration guide for ignite#2867 * docs: add migration guide for ignite#1921 * docs: remove proto migration from v0.25.1 since it's already present in migration v0.25.0 * docs: Dragonberry fix migration Also: - reorg migration guides between v0.25.1 and v0.25.0 - fix broken yaml in markdown headers * docs: format Co-authored-by: Thomas Bruyelle <[email protected]> Co-authored-by: Jerónimo Albi <[email protected]> Co-authored-by: Thomas Bruyelle <[email protected]>
Closes #2931
Please test these steps with a
v0.24.0
chain. The guide is pretty long, so I might be missing something.