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

[rendering-modes] New page! #4667

Merged
merged 40 commits into from
Nov 9, 2023
Merged

[rendering-modes] New page! #4667

merged 40 commits into from
Nov 9, 2023

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Sep 12, 2023

Description

This:

  • adds a new page called Rendering Modes replace the intro content on the SSR page
  • updates the sidebar nav to show Rendering Modes
  • moves the existing content about improving page performance via streaming to a separate Recipe
  • updates links on other docs pages if/as necessary depending on whether we want to link to a conceptual page or adding an adapter (also, probably updated headings even if pointing to the same page)

For future follow up (because it will touch a lot of pages):

  • replace existing text "SSR" (e.g. SSR mode, SSR adapters) to "server", "server-rendered", "on-demand rendered" etc. per the context.
  • check for older docs that only refer to server mode, because that's all there was when they were written!
  • consider renaming this page

PURPOSE:

  • The new "basics" page describes Astro's rendering modes (output: 'static', output: 'hybrid', and output: 'server') together all on a new page titled Rendering Modes.
  • This and a revamped SSR page (file-name to potentially change to on-demand-rendering but later, for less disruption) also leans into the phrases "pre-rendering" and "on-demand rendering" while downplaying SSG/SSR

Previously, we had

  • no real information at all about static, pre-rendering, because that's just what Astro "was".
  • only an SSR page that was not significantly refreshed since it was an experimental feature, and had grown by patchwork additions rather than being a united page

Therefore, we often had to describe the difference between all these modes in support threads, including when and why you might choose to use them.

The emphasis here shifts from "a page about SSR" to a core concepts page describing and comparing the three output modes and then a page about enabling server and hybrid as an "add on"

Direct preview link to the new page: https://deploy-preview-4667--astro-docs-2.netlify.app/en/core-concepts/rendering-modes/ and revamped SSR page: https://deploy-preview-4667--astro-docs-2.netlify.app/en/guides/server-side-rendering/

@sarah11918 sarah11918 added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Sep 12, 2023
@netlify
Copy link

netlify bot commented Sep 12, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 7b590ed
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/654d49b6317af30009375b19
😎 Deploy Preview https://deploy-preview-4667--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 configuration.

@sarah11918 sarah11918 self-assigned this Sep 17, 2023
@sarah11918 sarah11918 marked this pull request as ready for review October 21, 2023 17:08
@sarah11918 sarah11918 changed the title [draft - ssr] [rendering-modes] New page! Oct 21, 2023
@sarah11918
Copy link
Member Author

FRIDAY CHAOS... splitting this into two pages to better suit the proposed new sidebar sections...

Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

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

Seems like all of the questions and notes I had about these pages during talking and doc'ing are taken care of!

Really good pages!

src/content/docs/en/guides/server-side-rendering.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/server-side-rendering.mdx Outdated Show resolved Hide resolved
sarah11918 and others added 2 commits November 6, 2023 13:38
@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Nov 8, 2023
@sarah11918 sarah11918 merged commit c6bdb30 into main Nov 9, 2023
10 checks passed
@sarah11918 sarah11918 deleted the rendering-modes branch November 9, 2023 21:55
NinuzIBZ added a commit to NinuzIBZ/docs that referenced this pull request Feb 1, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits withastro#4876 , withastro#5183 , withastro#5213 , withastro#5271 , withastro#5187 , withastro#4667 , withastro#5541 , withastro#5605 , withastro#5499 , withastro#6470 , withastro#6620
@NinuzIBZ NinuzIBZ mentioned this pull request Feb 1, 2024
yanthomasdev added a commit that referenced this pull request Feb 5, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits #4876 , #5183 , #5213 , #5271 , #5187 , #4667 , #5541 , #5605 , #5499 , #6470 , #6620

Co-authored-by: Yan Thomas <[email protected]>
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. minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants