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

Unflag hybrid rendering docs #3353

Merged
merged 9 commits into from
Jun 6, 2023
Merged

Unflag hybrid rendering docs #3353

merged 9 commits into from
Jun 6, 2023

Conversation

matthewp
Copy link
Contributor

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)

Description

  • This is for the release of hybrid rendering as unflagged, tentatively in 2.6.
  • So far the only change is removing the experimental flag. I'm not sure if it's better to try and combine the "hybrid rendering" section above. Happy to take a pass at that if people think it would be better to explain at one time.

@netlify
Copy link

netlify bot commented May 26, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit ac94742
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/647f6a2b80fd930008b10e1f
😎 Deploy Preview https://deploy-preview-3353--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.

@sarah11918 sarah11918 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) labels May 26, 2023
@sarah11918
Copy link
Member

Sure! Go for it!

I see maybe a possible logical flow as:

  • hybrid rendering means SOME pages pre-rendered, and some not
  • New in Astro 2.6, there are two modes to determine what the default is, and therefore which pages need to be marked to do the non-default thing
  • For mostly static sites with some SSR (non-prerendered) pages, choose hybrid (new in Astro 2.6)
  • For mostly SSR pages, with the option to pre-render only some select pages, choose server (the only option available prior to Astro 2.6)

@sarah11918
Copy link
Member

(And, if you don't get around to it, just uncommenting the experimental flag would be fine, too!) 😄

@matthewp
Copy link
Contributor Author

Ok, I think it's worth trying to combine too. I'll make a pass and if you don't like it the commit can just be removed.

@matthewp
Copy link
Contributor Author

@sarah11918 Took a pass at it, let me know what you think.

@sarah11918
Copy link
Member

Hi @matthewp - I made #3378 as a PR to your branch since I found I wanted to edit some things outside of your changes here. For example we still had the bold line about every page being server-rendered once you enable SSR, which isn't true anymore.

I took the take that both modes are a way to get some (or all) SSR into your project, and defined/described them as such. There's a lot that's parallel between the two so thinking of them, and structuring the page that way is quite clean. We might decide we don't like that, but I think there's ultimately some value in that clarity, so I wanted to consider it. (Framing it that way vs hybrid rendering being it's own weird thing does make me think that the name hybrid feels a little off, so that's one reason not to do it. Both server and hybrid allow for a combination, or hybrid, of rendering... 😅 )

See what you think in the other PR, and like I wrote there, it doesn't have to be the final call. But if we like that structure/framing, then we can take this from there.

@sarah11918
Copy link
Member

Also, just a reminder for us that there should be a corresponding withastro/astro/ PR that removes this option entirely from configuration-reference like the PR for custom client directives here: withastro/astro#7237 I think that's all that needs to happen in the other repo for docs.

@natemoo-re natemoo-re mentioned this pull request May 31, 2023
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label May 31, 2023
@matthewp
Copy link
Contributor Author

Happy with how this landed!

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Happy, too! 🥳

@sarah11918 sarah11918 removed the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jun 2, 2023
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jun 6, 2023
@sarah11918 sarah11918 merged commit 0b7b494 into main Jun 6, 2023
@sarah11918 sarah11918 deleted the hybrid-rendering-unflagged branch June 6, 2023 17:30
@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) 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" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants