Skip to content

[upgrade guide] [i18nIgnore] Add upgrade to v2 guide + moving pieces#2330

Merged
sarah11918 merged 89 commits into
mainfrom
upgrade-to-v2
Jan 24, 2023
Merged

[upgrade guide] [i18nIgnore] Add upgrade to v2 guide + moving pieces#2330
sarah11918 merged 89 commits into
mainfrom
upgrade-to-v2

Conversation

@sarah11918
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 commented Jan 9, 2023

Creates an "Upgrade v1 -> v2" guide, and makes all the necessary infrastructure changes:

  • adds "Upgrade to v2" in the Start Here section of the nav bar
  • creates a new /guides/upgrade-to/v2.mdx page
  • renames the previous migrate.mdx file to /guides/upgrade-to/v1.mdx (this can eventually be deleted if we decide. "migrating to older versions?" link will go to a fixed GitHub commit version of this file so that it can be removed from docs)
  • redirects /en/migrate/ and older existing /en/migrate/0.21.0 redirect to /en/guides/upgrade-to/v2 in netlify.toml instead of an Astro page file.
  • references this guide on the Getting Started docs landing page

Thank you @delucis for suggestions re: finer strategy points!

  • [x ] TODO: Write the content! 😅
    (Will start by mostly faithfully reproducing Changelog content; update to better "guide" content incrementally.)

ALSO TODO:

  • Convert code samples to Docs (not GitHub) format
  • Decide/consitenc-ize how we refer to Astro versions
  • ~~[x] reference new guide on main Getting Started page ~~ (Will make separate PR that's not ignored by translators)
  • decide for sure if this belongs in root, or under "guides"
  • if under guides, then update netlify.toml redirects
  • decide whether to link to old v1 upgrade guide on GitHub or in docs (currently GitHub)

@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 9, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit fb2580c
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/63cffc11af3d88000853bbf1
😎 Deploy Preview https://deploy-preview-2330--astro-docs-2.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 settings.

Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Left a note about redirects. Will you delete the migrate-to-v1.mdx file before merging? Don’t think we need to keep that content around.

I think you can delete the translations of /migrate/ in this PR too. That would fix the “Mismatched Slugs” check.

Comment thread src/pages/en/migrate.astro Outdated
@github-actions github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 9, 2023
Comment thread src/pages/en/upgrade-astro.mdx Outdated
@yanthomasdev
Copy link
Copy Markdown
Member

yanthomasdev commented Jan 9, 2023

withastro/astro PR fixing the last broken links: withastro/astro#5808 (marked as a draft but can be merged at anytime)

@yanthomasdev yanthomasdev changed the title [upgrade guide] Updates docs content for publishing an upgrade to v2 guide [upgrade guide] [i18nIgnore] Updates docs content for publishing an upgrade to v2 guide Jan 9, 2023
@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. and removed i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! labels Jan 10, 2023
@sarah11918 sarah11918 changed the title [upgrade guide] [i18nIgnore] Updates docs content for publishing an upgrade to v2 guide [upgrade guide] [i18nIgnore] Add upgrade to v2 guide + moving pieces Jan 10, 2023
@github-actions github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 10, 2023
@sarah11918 sarah11918 removed the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 10, 2023
@github-actions github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 10, 2023
@sarah11918 sarah11918 removed the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 11, 2023
@github-actions github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jan 11, 2023
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx
@sarah11918
Copy link
Copy Markdown
Member Author

Thanks for the excellent review @delucis! I'm happy to go through and reorder for impact.

You make a great point, probably completely removing deprecated things probably affects the fewest projects , even if it they in a way are the most "final" absolutely breaking changes.

I'll take a quick pass at "importance/impact" now, to at least get start with importance because we can probably improve it immediately. Would love to dig into the data to verify some assumptions, if that's something we can get around to!

Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
@sarah11918 sarah11918 marked this pull request as ready for review January 23, 2023 14:40
Copy link
Copy Markdown
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

Great work @sarah11918, I added a few suggestions but LGTM!

Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Quick couple of notes but this looks good! I also still need to add a note for the changed behaviour in the latest Svelte integration.

Comment thread src/pages/en/guides/upgrade-to/v2.mdx Outdated
@sarah11918 sarah11918 merged commit b2f8282 into main Jan 24, 2023
@sarah11918 sarah11918 deleted the upgrade-to-v2 branch January 24, 2023 15:53
@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day. label Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants