10000 Update adapters and their deploy guides re: `output:'server'` by sarah11918 · Pull Request #11497 · withastro/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update adapters and their deploy guides re: output:'server' #11497

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

Merged
merged 20 commits into from
Apr 28, 2025

Conversation

sarah11918
Copy link
Member
@sarah11918 sarah11918 commented Apr 21, 2025

Description (required)

This PR updates our four adapter guides and their corresponding deploy guides which currently show output: "server" as the default when you add an adapter.

As described in #11245, server mode is not added when running astro add for adapters, and it is no longer required (as it was at the time of original writing). Moreover, we now explicitly suggest not to automatically configure server mode, and wait until you have a need for it. So, our examples should not show this as the default configuration when you have an adapter.

Additionally, there is duplication in our deploy guides which also show how to add and configure an adapter. These should instead link to the adapter guide to reduce code and maintenance.

Tasks

  • remove output: 'server' from standard examples
  • improve adapter introduction to also highlight on demand features (server islands, actions, sessions) so it's more clear when an adapter might be needed
  • replace "SSR" in adapter pages with an appropriate substitution depending on the context (e.g. "on demand rendering", "server rendering"), including i18n/en.yml
  • remove and instead link to installing an adapter from the deployment guides
  • update the <StaticSSRTabs> component to use translatable tab titles
  • make a PR to astro for the configuration reference changes ( [docs] better text/links in config ref adapter entry astro#13698 ) which created a "zero line change" PR ci: update configuration reference docs #11544 included here
  • Note: I don't think there will be any conflicts, but since waiting for fix: update cloudflare integration guide #11506 to merge first since this touches that same page.

Related issues & labels (optional)

Copy link
netlify bot commented Apr 21, 2025

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 984a7f9
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/680f6c496eb1980008bb74e2
😎 Deploy Preview https://deploy-preview-11497--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 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) code snippet update Updates a code sample: typo, outdated code etc. labels Apr 21, 2025
@astrobot-houston
Copy link
Contributor
astrobot-houston commented Apr 21, 2025

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/guides/deploy/cloudflare.mdx Source changed, localizations will be marked as outdated.
en/guides/deploy/netlify.mdx Source changed, localizations will be marked as outdated.
en/guides/deploy/vercel.mdx Source changed, localizations will be marked as outdated.
en/guides/integrations-guide/cloudflare.mdx Source changed, localizations will be marked as outdated.
en/guides/integrations-guide/netlify.mdx Source changed, localizations will be marked as outdated.
en/guides/integrations-guide/node.mdx Source changed, localizations will be marked as outdated.
en/guides/integrations-guide/vercel.mdx Source changed, localizations will be marked as outdated.
en/reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
src/content/i18n/en.yml 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
@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

I only left a few suggestions due to typos.

Also, since this is more or less within the scope of this PR, should we update the SSR mentions in the following places:

I mean it depends on whether we want to update the wording everywhere or keep some for SEO. While search engines are probably smart enough now to make the connection between "server-rendered" and "SSR" (kinda synonyms), maybe having "SSR" explicitly in the page can help with ranking.

Otherwise, looks good to me! But, I would like to point out that, clearly, it's a passion to break the links! 😆 (OK, it would help if the translations were up to date... 😅 )

sarah11918 and others added 2 commits April 21, 2025 22:00
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
@sarah11918
Copy link
Member Author
sarah11918 commented Apr 21, 2025

Re: Cloudflare deployment page: I remember now, because the Cloudflare deploy guide was recently updated. At the time, we couldn't be bothered to update our pre-built <StaticSSRTabs> component, which automatically uses SSR as a tab header. So, we kept the "also known as SSR" in there, so that it would at least match up with the component.

image

So, I will update the one you mentioned, but we can't totally vanquish it from this page without also updating the component! 🤪

Yes, I think we can update the .yml file to just say "Adapters"! Great call!

Update:

Oooh, I stand corrected: Looks like I can get at that from the en.yml file, too!

image

@ArmandPhilippot
Copy link
Member
ArmandPhilippot commented Apr 21, 2025

Oh yeah, that makes sense now, I didn't remember what was said in that PR! Great catch with the other UI string, but it seems these keys (ssr/static) are not used anywhere 😅 They was probably meant for the component, but right now the labels are hardcoded:

<Tabs syncKey="deploy-type">
<TabItem label="Static">
<slot name="static" />
</TabItem>
<TabItem label="SSR">
<slot name="ssr" />
</TabItem>
</Tabs>

Edit: if you want to update the component in this PR, I think we only need to use Astro.locals.t:

<Tabs syncKey="deploy-type">
	<TabItem label={Astro.locals.t('deploy.staticTag')}>
		<slot name="static" />
	</TabItem>
	<TabItem label={Astro.locals.t('deploy.ssrTag')}>
		<slot name="ssr" />
	</TabItem>
</Tabs>

@sarah11918
Copy link
Member Author

Ah, tu as raison!

image

OK, let's change the component while we're here! (Chris is away... we can get away with this...)

Copy link
Member
@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

The tabs are now translated! 🎉 I left another suggestion to fix a link, other than that LGTM!

Co-authored-by: Armand Philippot <git@armand.philippot.eu>
@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Apr 27, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
Nin3lee added a commit to Nin3lee/docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code snippet update Updates a code sample: typo, outdated code etc. 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!)
Projects
None yet
3 participants
0