Skip to content
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

Merged
merged 32 commits into from
Nov 2, 2022
Merged

docs: cosmoscmd migration #2949

merged 32 commits into from
Nov 2, 2022

Conversation

aljo242
Copy link
Contributor

@aljo242 aljo242 commented Oct 19, 2022

Closes #2931

Please test these steps with a v0.24.0 chain. The guide is pretty long, so I might be missing something.

@aljo242 aljo242 requested review from ilgooz and lumtis as code owners October 19, 2022 18:14
@aljo242 aljo242 added the skip-changelog Don't check changelog for new entries label Oct 19, 2022
@tbruyelle
Copy link
Contributor

tbruyelle commented Oct 20, 2022

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 // highlight-next-line instruction! Basically you put that before a line you want to highlight (in our case a line that has changed), and it appears hightlighted. Example for app/app.go :

Since I applied the migration on a chain, I can just run git diff to see where those instructions should be added, you can find that in this patch file.


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.

Alex Johnson and others added 7 commits October 20, 2022 10:54
@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2022

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

@aljo242
Copy link
Contributor Author

aljo242 commented Oct 20, 2022

Incredible @tbruyelle, thank you !

Copy link
Contributor

@RaulBernal RaulBernal left a 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

docs/docs/migration/v0.25.0.md Show resolved Hide resolved
@RaulBernal
Copy link
Contributor

RaulBernal commented Oct 21, 2022

This changes are based in a SDK v0.45.x or v0.46.x ? For the second I guess
I think on Monday I will tweak it for v0.45
Thanks

@aljo242
Copy link
Contributor Author

aljo242 commented Oct 21, 2022

@tbruyelle some help with docusaurus config would be great!

@aljo242
Copy link
Contributor Author

aljo242 commented Oct 21, 2022

This changes are based in a SDK v0.45.x or v0.46.x ? For the second I guess I think on Monday I will tweak it for v0.45 Thanks

Yes, the latest version of ignite scaffolds v0.46.x chains, but removing cosmoscmd could be done for a v0.45.x or v0.46.x chain.

@tbruyelle
Copy link
Contributor

@tbruyelle some help with docusaurus config would be great!

Sure, do you want to add a custom magic comment to highlight removed lines ?

@aljo242
Copy link
Contributor Author

aljo242 commented Oct 31, 2022

@tbruyelle some help with docusaurus config would be great!

Sure, do you want to add a custom magic comment to highlight removed lines ?

Yes please 👍

@tbruyelle
Copy link
Contributor

@tbruyelle some help with docusaurus config would be great!

Sure, do you want to add a custom magic comment to highlight removed lines ?

Yes please +1

It's there 5a3aa9a

I added one magic comment as an example, you need to add the others :)
image

@aljo242
Copy link
Contributor Author

aljo242 commented Oct 31, 2022

@tbruyelle thanks for all of the help. Changes made here

@aljo242 aljo242 added the component:docs Documentation additions or improvements. label Oct 31, 2022
@aljo242 aljo242 self-assigned this Nov 1, 2022
@tbruyelle
Copy link
Contributor

@aljo242 I see 2 other things we may address in the 0.25 migration :

Wdyt ? The changes concern the app/app.go file, should we merge them with the current migration ? (I can address them, I noticed the changes while comparing app.go with a chain in 0.24 and an other in 0.25)

@tbruyelle
Copy link
Contributor

@tbruyelle thanks for all of the help. Changes made here

Sorry I couldn't stop myself from adding more magic comments :P 6b327ea

@aljo242
Copy link
Contributor Author

aljo242 commented Nov 2, 2022

@aljo242 I see 2 other things we may address in the 0.25 migration :

Wdyt ? The changes concern the app/app.go file, should we merge them with the current migration ? (I can address them, I noticed the changes while comparing app.go with a chain in 0.24 and an other in 0.25)

Yes, we should add these as well - great catch! I would really appreciate it if you added. You're a docs legend

@tbruyelle
Copy link
Contributor

@aljo242 I see 2 other things we may address in the 0.25 migration :

Wdyt ? The changes concern the app/app.go file, should we merge them with the current migration ? (I can address them, I noticed the changes while comparing app.go with a chain in 0.24 and an other in 0.25)

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
@tbruyelle
Copy link
Contributor

@aljo242 843d0a1

  • Moved all v0.25.1 items to v0.25.0
  • Added a section for the Dragonberry fix in v0.25.1
  • Fixed broken yaml in some markdown headers

@aljo242
Copy link
Contributor Author

aljo242 commented Nov 2, 2022

Amazing! merging!

@aljo242 aljo242 merged commit 6686bb6 into develop Nov 2, 2022
@aljo242 aljo242 deleted the docs/cosmoscmd-migration branch November 2, 2022 18:12
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation additions or improvements. skip-changelog Don't check changelog for new entries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add migration rules for v0.25.1 after removed of cosmoscmd
4 participants