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

docs: Add information about dynamic static split server islands #10106

Conversation

Jacob-Roberts
Copy link

Description (required)

This PR is the documentation follow-on to this PR which adds the ability to serve the server islands from a separate domain.

For Astro version: 5.0. See astro PR 12320.

First-time contributor to Astro Docs?

jake_roberts

Copy link

netlify bot commented Nov 25, 2024

Deploy Preview for astro-docs-2 failed. Why did it fail? →

Built without sensitive environment variables

Name Link
🔨 Latest commit e9ae88b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6744f8fb6a54c400082a8683

@astrobot-houston
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/reference/integrations-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

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.

Hi @Jacob-Roberts , thanks for submitting documentation for your feature! 🚀

I took a look at the initial PR, and I haven't seen the code approved yet, and docs can never be edited before we know that the feature is complete and approved anyway, in case some details or implementation change during the code review process. So just letting you know this will have to sit and wait on the feature being accepted. (And, it's possible being so close to a v5 release that there may not yet be another beta release, in which case I don't know whether devs would accept a new feature without being able to at least release it in a beta first? Just a heads up on that, too! This is cutting it SUPER close for comfort! But, I'll wait and see what happens there!)

In the mean time, I've left a comment about needing an example though!

This hook gives you the opportunity to add private config options that are exposed only to integrations.
There are certain options that are not directly exposed to users, but are allowed to be written from integrations.

For example, the astro config [`serverIslandDynamicBase`](https://github.com/withastro/astro/blob/30d720f519f991720ee0b7c328a4bf4bbf31760d/packages/astro/src/types/public/config.ts#L1979-L1986)
Copy link
Member

Choose a reason for hiding this comment

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

Heads up that we do not typically link to code outside of docs. Everything in docs should be fully explained so people don't have to leave the page. A full example would have to be provided here.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) 5.0.0-beta labels Nov 26, 2024
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.

Just putting a block on this PR so it doesn't accidentally get merged as this feature will not be released before v5.

@sarah11918
Copy link
Member

Noting that this PR was auto closed when v5 docs updated. We will need a new docs PR for this! @Jacob-Roberts , could you please look at my comments here and create a new PR?

@sarah11918
Copy link
Member

sarah11918 commented Dec 3, 2024

Ooh, it's not letting me reopen because the beta branch no longer exists... so that's why we need a new PR!

@Jacob-Roberts
Copy link
Author

Jacob-Roberts commented Dec 4, 2024

Thanks @sarah11918! I'll submit a new PR.

Moved to #10194

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. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants