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: add v3 migration guide #2008

Merged

Conversation

jonaslagoni
Copy link
Member

@jonaslagoni jonaslagoni commented Jul 28, 2023

Description
This PR is a replacement for #660

This PR adds a migration page for version 3 that shows the difference between v2 and v3 in an interactive manner.

Related issue(s)
Related to asyncapi/spec#691

@netlify
Copy link

netlify bot commented Jul 28, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit e3962c6
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/654050e96689fd0008946b34
😎 Deploy Preview https://deploy-preview-2008--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

Hi @jonaslagoni, Thanks for initiating this PR. The new doc page for migration to v3 is looking great. Here are some of my concerns I think you should consider in mobile view.

image

If we are following comparison boxes to be ordered in a vertical fashion, it should be followed all over the page. So, just update this v2 & v3 comparison to be in vertical alignment in mobile view, as you did for others.

image

There should be some minimum gap between these two comparison boxes in mobile view. Kindly add a gap property in them if you have made them using flexbox. Applicable everywhere.

Copy link
Contributor

@AnimeshKumar923 AnimeshKumar923 left a comment

Choose a reason for hiding this comment

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

I've reviewed the files as per my capabilities. Please have a look and provide your feedback 🙏 @jonaslagoni @alequetzalli @thulieblack

pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
pages/docs/migration/migrating-to-v3.md Outdated Show resolved Hide resolved
@jonaslagoni
Copy link
Member Author

@akshatnema do you have a suggestion as to how the class names need to change to satisfy the design you are looking for?

@jonaslagoni
Copy link
Member Author

@AnimeshKumar923 thanks for the feedback, applied most of the suggestions, some needs to be discussed 🙂

@AnimeshKumar923
Copy link
Contributor

@AnimeshKumar923 thanks for the feedback, applied most of the suggestions, some needs to be discussed 🙂

Okay. Let me know, how to discuss these...

@jonaslagoni
Copy link
Member Author

@AnimeshKumar923 in your comments 🙂 I left some further suggestions and in #2008 (comment) I cant come up with anything better, so hoping @alequetzalli will jump in 😄

@AnimeshKumar923
Copy link
Contributor

AnimeshKumar923 commented Jul 31, 2023

@AnimeshKumar923 in your comments 🙂 I left some further suggestions and in #2008 (comment) I cant come up with anything better, so hoping @alequetzalli will jump in 😄

Will look into it later 👍🏻

@akshatnema
Copy link
Member

@akshatnema do you have a suggestion as to how the class names need to change to satisfy the design you are looking for?

@jonaslagoni Should I directly commit the changes or made them as suggestions inside this PR?

components/Asyncapi3Comparison.js Show resolved Hide resolved
components/Asyncapi3Comparison.js Show resolved Hide resolved
@fmvilas
Copy link
Member

fmvilas commented Oct 10, 2023

@akshatnema would you mind having a look? 🙏

@jonaslagoni
Copy link
Member Author

Please have another look @akshatnema 🙂

@jonaslagoni
Copy link
Member Author

After this is merged I am gonna add the parameters section.

akshatnema
akshatnema previously approved these changes Oct 20, 2023
Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

LGTM ✔️

@derberg
Copy link
Member

derberg commented Oct 24, 2023

@alequetzalli we're just missing your approval I think

@quetzalliwrites
Copy link
Member

@alequetzalli we're just missing your approval I think

Hey @derberg, I committed a rewrite here -- this doc is amazing, but still needed several fixes. Now we're good to merge. ✌🏽

Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

🪄✨✨

@derberg
Copy link
Member

derberg commented Oct 31, 2023

@alequetzalli thanks a lot

@jonaslagoni you wanna have a final look after rewrite from Alejandra? sometimes such rewrite/refactor can affect the message (there are no unit tests for docs 😄 ), so just wanna double check if you wanna have a look before merging

@jonaslagoni
Copy link
Member Author

LGTM 👍

@jonaslagoni
Copy link
Member Author

/rtm

@jonaslagoni
Copy link
Member Author

@akshatnema think this needs you approval, or @derberg

@akshatnema
Copy link
Member

/rtm

@akshatnema
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 1b3e938 into asyncapi:next-major-spec Nov 2, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants