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(gatsby-plugin-image): Initial migration guide #29036

Merged
merged 55 commits into from
Jan 25, 2021

Conversation

laurieontech
Copy link
Contributor

This is a draft of the migration guide.

[ch22957]

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jan 14, 2021
Copy link
Contributor

@meganesu meganesu left a comment

Choose a reason for hiding this comment

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

This is definitely on the right track! 🙌 I think all the right pieces of information are here, but there might be a better way to group them. The way I'm chunking this content in my head looks something like:

  • Introduction (there's a new plugin!)
  • What changed?
    • New Syntax
    • API changes
    • Unsupported usage
  • How to migrate?
    • Install
    • Codemod instructions
      • Codemod assumptions
    • Recommended changes (I got the sense that these were additional changes needed on top of the codemod?)

What do you think?

@vladar vladar added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jan 15, 2021
Copy link
Contributor

@ascorbic ascorbic left a comment

Choose a reason for hiding this comment

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

Just a few comments. I've done them as change suggestions, but that's just as it's easier. I'm not expecting you to use my words

docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
@laurieontech laurieontech marked this pull request as ready for review January 21, 2021 17:35
ascorbic
ascorbic previously approved these changes Jan 22, 2021
Copy link
Contributor

@ascorbic ascorbic left a comment

Choose a reason for hiding this comment

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

@meganesu should check too, but this looks great to me. :shipit:

Copy link
Contributor

@meganesu meganesu left a comment

Choose a reason for hiding this comment

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

This looks awesome! Left a bunch of copy edits, but after those this looks ready to me! Great job 🎉 ✨

docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
docs/docs/reference/release-notes/image-migration-guide.md Outdated Show resolved Hide resolved
@laurieontech laurieontech added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Jan 22, 2021
@laurieontech laurieontech merged commit f00b929 into master Jan 25, 2021
@laurieontech laurieontech deleted the image-migration-guide branch January 25, 2021 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants