withastro
feat: add a semantic versioning document for Astro
Description (required)
This PR adds a new page called Upgrade Astro. I mainly created this page because we—the platform team—needed a document that frames Astro's semantic versioning contract.
Considering the entity of the document, we felt that the docs website was the best place to have it. This document is meant for end users, integration developers, adapters developers and us - the core team.
We recently discussed some changes we wanted to ship, and we couldn't agree. This PR will serve as:
- discussion hub to land on a unified semantic versioning contract;
- to have a broader page that involves everything about "updating" Astro.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Updated (UTC) |
|---|---|---|---|
| docs | ✅ Ready (Inspect) | Visit Preview | Mar 25, 2024 4:58pm |
1 Ignored Deployment
| Name | Status | Preview | Updated (UTC) |
|---|---|---|---|
| docs-i18n | ⬜️ Ignored (Inspect) | Mar 25, 2024 4:58pm |
![vercel[bot] avatar](https://avatars.githubusercontent.com/in/8329?v=4 "Published by a pub.dev verified publisher"){kind=small}
Thanks @ematipico ! I will be looking into this over the next few days. We will probably wait to merge it until we can add more content to make this a great, general "Update" page... but we'll get on it!
Some of the things I have in mind include:
- very clearly displaying the current version of Astro and instructions to update version (and/or to downgrade/install any particular version)
- link to changelog
- links to all past migration guides
- ... whatever else we think of! ideas welcome!
@ematipico I took a first pass at Semantic versioning editing, and added my own TODOS for the rest of the page. You are welcome to review/edit/fix any of my changes so far!
Latest version open for reviews!
NOTE: Still to-do will be to remove the specific link "Upgrade to v4" from the sidebar
Great work!
About deprecated APIs, our strategy seems to be to keep one major version each time? Until the second major version completely removes it?
Do you think it needs to be stated on this page?
🚨 ATTENTION 🚨
This one shouldn't be i18nIgnore'd, paste this into the merge commit's description and Lunaria will do its thing:
@lunaria-ignore:src/i18n/**/nav.ts
@tracker-minor:src/i18n/**/nav.ts;./src/i18n/**/nav.ts;
