-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs: document Environment API breaking changes #12809
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
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
left a comment
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.
Thanks Matthew, this looks great. I left a few suggestions, mostly about headings/code snippet consistency.
My main concern is the "RouteData.generate() Removed" section. I don't think we document RouteData directly, but I can see it used in the Integrations page to transmit properties. Looking at the implementation PR, it seems generate() still exist under another format. So, maybe this is the change we want to document here? (but maybe I'm wrong, the implementation PR contains a lot of changes, I haven't checked all the details yet 😅 )
Also, while I was quickly looking at the implementation PR, I noticed we have two new properties for setAdapter(): we'll need to document them in the Adapter API guide under Building an adapter. We now have a subheading for each available prop, so we'll need to add devEntrypoint and entryType there.
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
|
I just added a commit to reorganize and start to put these in our format.
|
|
@sarah11918 to understand what is next, it looks like you've made the changes from the comment yourself. Is there anything remaining for me to do? I need to find places in the regular docs related to these changes and update those? Anything else? |
|
@matthewp I hope it's not too inconvenient, since I needed to move things around it was easier for me to make a single commit. I normally prefer leaving suggestions, but that wouldn't have been efficient here! What you can do:
What I will do with @ArmandPhilippot :
|
sarah11918
left a comment
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.
OK, left a note on each individual entry with either "docs don't need updating" confirmation, or the things for @matthewp to look at current docs to see if updates are necessary there (and/or questions for @ArmandPhilippot to help get that done!)
So current Matthew tasks are:
- review each individual entry as written here for the upgrade guide and make any suggestions needed
- address each of these following 7 comments (you can resolve the ones that say no docs changes needed!) so we know we're aligning docs with these updates
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
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.
OK, I think I am happy with the upgrade guide content, and I've updated the Integration API reference page to remove mention of target.
There are two Future Team Docs documentation challenges (SerializedSSRManifest and RouteData/IntegrationResolvedRoute that we can consider.
Currently, on line 1052 of the Integration API page (edited in this PR, but just out of view of the changes), there is a link to specific lines in source code. It would be great to confirm that those lines are the same even on the Updated, thank you Armand!next branch after this refactor? But worst case, we can figure that out later when revisiting SerializedSSRManifest.
|
Will wait for checks and Netlify so I can check the deploy preview visually, but otherwise, I think the content here seems fine now! |
sarah11918
left a comment
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.
@matthewp , @ArmandPhilippot - this has my blessing if everything is acceptable to y'all!
ArmandPhilippot
left a comment
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.
I left a small nit, but this LGTM! 🎉
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
yanthomasdev
left a comment
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.
A few nits from me and then LGTM
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
|
This is so exciting!! I know the Environment API refactors have been a massive effort from the entire core framework team. I hope we've done y'all justice in docs, and will merge this into the v6 branch. There's lots of time before v6 if anyone spots anything in the upgrade guide after the fact, but let's all enjoy this being DONE! |
|
Thanks @sarah11918 ! |
Description (required)
Updates the v6 guide with breaking changes from the Environment API refactor
Related issues & labels (optional)
For Astro version:
6.x. See astro PR #14306.