Skip to content

Add working upgrade guide#179

Merged
cartogram merged 2 commits intomainfrom
migration-guide
Nov 9, 2022
Merged

Add working upgrade guide#179
cartogram merged 2 commits intomainfrom
migration-guide

Conversation

@cartogram
Copy link
Contributor

We've been adding RFCs in this repo and writing the documentation early as we've been building out the new abstractions. In the same, let's start writing the full upgrade guide from v1 to v2.

Why?

  • Seeing all the changes together in one place is a different perspective and it makes it easier to see the overlap.
  • This is the first step to automating any of the migration steps.
  • Helps take the burden off @rennyG and gives us more time to refine these as we go.

What?

In this PR I've just written a few things in a table of contents, but some ideas for how we write this.

  • Write before/after code samples as much as possible.
  • Specify tasks that need to be done before upgrading/after upgrading, if applicable.

@cartogram cartogram requested a review from a team November 9, 2022 15:33
Copy link
Contributor

@jplhomer jplhomer left a comment

Choose a reason for hiding this comment

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

Fuck yeah - let's get this going. It will be a forcing function to both document things and realize what pieces we are missing.

@cartogram cartogram marked this pull request as ready for review November 9, 2022 15:44
@cartogram cartogram changed the title [WIP] Upgrade guide Add working upgrade guide Nov 9, 2022
@rennyG
Copy link
Contributor

rennyG commented Nov 9, 2022

Much appreciated! Let's have a quick sync about where these docs will live. I think it makes more sense to have them in shopify-dev. In addition, we'll want this to follow accepted patterns for Shopify.dev. @cartogram want to meet and discuss?

@cartogram cartogram merged commit 38defa5 into main Nov 9, 2022
@cartogram cartogram deleted the migration-guide branch November 9, 2022 18:50
Copy link
Contributor

@juanpprieto juanpprieto left a comment

Choose a reason for hiding this comment

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

  • Hydrogen-UI components

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants