-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Migration guide polish and examples #10889
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sophschneider
force-pushed
the
sophie/migration-guide-styles
branch
from
October 5, 2023 15:09
c313a4e
to
f45c51b
Compare
sophschneider
force-pushed
the
sophie/migration-guide-styles
branch
3 times, most recently
from
October 5, 2023 16:43
0c79f1a
to
69b8b99
Compare
sophschneider
force-pushed
the
sophie/migration-guide-styles
branch
from
October 5, 2023 16:45
69b8b99
to
19099cf
Compare
laurkim
reviewed
Oct 5, 2023
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Lo Kim <lo.kim@shopify.com>
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
laurkim
reviewed
Oct 5, 2023
polaris.shopify.com/content/version-guides/migrating-from-v11-to-v12.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Lo Kim <lo.kim@shopify.com>
laurkim
approved these changes
Oct 5, 2023
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.
💯 🌟 🚀
Co-authored-by: Lo Kim <lo.kim@shopify.com>
mrcthms
pushed a commit
that referenced
this pull request
Oct 12, 2023
Fixes #10806 1. Added support for `<details>` toggles on markdown 2. Added support for `collabsibleTOC` pages (off by default) so you can quickly skip to the section you need. This isn't perfect yet (doesn't auto open when linking directly to an anchor) but is much better than what we currently have 3. Organized v11 to v12 styleguide into consistent steps 4. Put regex validation, mapping tables, and examples in details toggles to make the page less overwhelming and put migration commands at the forefront 5. Added introduction, glossary, and generalized the migration workflow section. Put these at the top to introduce builders to the migration 6. Added descriptive titles to all component migrations naming what they do 7. Added examples to each component migration and removed them from the "Whats new" page 8. Added regex validation snippets to all component migrations 9. Added alert text for stepped migrations that have to be run in order 10. Cleaned up copy and overall improved migration experience giving more context on how and why we are running the migrations. Aimed to make it clear enough that an intern could run a migration on their code base 11. Add padding to code blocks ![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2) ![Screen Recording 2023-10-05 at 3 09 18 PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302) --------- Co-authored-by: Lo Kim <lo.kim@shopify.com>
mrcthms
pushed a commit
that referenced
this pull request
Oct 12, 2023
Fixes #10806 1. Added support for `<details>` toggles on markdown 2. Added support for `collabsibleTOC` pages (off by default) so you can quickly skip to the section you need. This isn't perfect yet (doesn't auto open when linking directly to an anchor) but is much better than what we currently have 3. Organized v11 to v12 styleguide into consistent steps 4. Put regex validation, mapping tables, and examples in details toggles to make the page less overwhelming and put migration commands at the forefront 5. Added introduction, glossary, and generalized the migration workflow section. Put these at the top to introduce builders to the migration 6. Added descriptive titles to all component migrations naming what they do 7. Added examples to each component migration and removed them from the "Whats new" page 8. Added regex validation snippets to all component migrations 9. Added alert text for stepped migrations that have to be run in order 10. Cleaned up copy and overall improved migration experience giving more context on how and why we are running the migrations. Aimed to make it clear enough that an intern could run a migration on their code base 11. Add padding to code blocks ![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2) ![Screen Recording 2023-10-05 at 3 09 18 PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302) --------- Co-authored-by: Lo Kim <lo.kim@shopify.com>
AnnaCheba
pushed a commit
to AnnaCheba/polaris
that referenced
this pull request
Apr 22, 2024
Fixes Shopify#10806 1. Added support for `<details>` toggles on markdown 2. Added support for `collabsibleTOC` pages (off by default) so you can quickly skip to the section you need. This isn't perfect yet (doesn't auto open when linking directly to an anchor) but is much better than what we currently have 3. Organized v11 to v12 styleguide into consistent steps 4. Put regex validation, mapping tables, and examples in details toggles to make the page less overwhelming and put migration commands at the forefront 5. Added introduction, glossary, and generalized the migration workflow section. Put these at the top to introduce builders to the migration 6. Added descriptive titles to all component migrations naming what they do 7. Added examples to each component migration and removed them from the "Whats new" page 8. Added regex validation snippets to all component migrations 9. Added alert text for stepped migrations that have to be run in order 10. Cleaned up copy and overall improved migration experience giving more context on how and why we are running the migrations. Aimed to make it clear enough that an intern could run a migration on their code base 11. Add padding to code blocks ![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2) ![Screen Recording 2023-10-05 at 3 09 18 PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302) --------- Co-authored-by: Lo Kim <lo.kim@shopify.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #10806
<details>
toggles on markdowncollabsibleTOC
pages (off by default) so you can quickly skip to the section you need. This isn't perfect yet (doesn't auto open when linking directly to an anchor) but is much better than what we currently have