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

5.0.0 beta docs #9240

Draft
wants to merge 287 commits into
base: main
Choose a base branch
from
Draft

5.0.0 beta docs #9240

wants to merge 287 commits into from

Conversation

delucis
Copy link
Member

@delucis delucis commented Aug 29, 2024

Description (required)

This is the WIP branch for the documentation changes for Astro v5, soon to be in beta.

Documentation may be incomplete, but feel free to use the deploy preview if you are trying out an early release of Astro v5: https://5-0-0-beta.docs.astro.build/

To do before merging

  • Remove / redirect added in 8b2b3eb
  • Remove v5 beta badge in site header added in 8e56929
  • Update the docgen script to point to the new location for configuration types in the Astro repo in frontmatter etc.
  • Revert editLink change made in b3dea25.
  • Disable Pagefind and enable the Search component override changed in ca7d812

Copy link

netlify bot commented Aug 29, 2024

Deploy Preview for astro-docs-2 ready!

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

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Aug 29, 2024

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

Locale File Note
ar concepts/why-astro.mdx Localization changed, will be marked as complete.
ar guides/integrations-guide/sitemap.mdx Localization changed, will be marked as complete. 🔄️
de guides/cms.mdx Localization changed, will be marked as complete. 🔄️
de guides/upgrade-to/v3.mdx Localization changed, will be marked as complete.
de reference/api-reference.mdx Localization changed, will be marked as complete. 🔄️
en basics/astro-components.mdx Source changed, localizations will be marked as outdated.
en basics/astro-pages.mdx Source changed, localizations will be marked as outdated.
en basics/astro-syntax.mdx Source changed, localizations will be marked as outdated.
en basics/layouts.mdx Source changed, localizations will be marked as outdated.
en basics/project-structure.mdx Source changed, localizations will be marked as outdated.
en basics/rendering-modes.mdx Source changed, localizations will be marked as outdated.
en basics/rendering.mdx Source added, will be tracked.
en concepts/islands.mdx Source changed, localizations will be marked as outdated.
en concepts/why-astro.mdx Source changed, localizations will be marked as outdated.
en getting-started.mdx Source changed, localizations will be marked as outdated.
en guides/actions.mdx Source changed, localizations will be marked as outdated.
en guides/astro-db.mdx Source changed, localizations will be marked as outdated.
en guides/backend/google-firebase.mdx Source changed, localizations will be marked as outdated.
en guides/backend/supabase.mdx Source changed, localizations will be marked as outdated.
en guides/client-side-scripts.mdx Source changed, localizations will be marked as outdated.
en guides/cms/contentful.mdx Source changed, localizations will be marked as outdated.
en guides/cms/decap-cms.mdx Source changed, localizations will be marked as outdated.
en guides/cms/keystatic.mdx Source changed, localizations will be marked as outdated.
en guides/cms/preprcms.mdx Source changed, localizations will be marked as outdated.
en guides/cms/storyblok.mdx Source changed, localizations will be marked as outdated.
en guides/cms/strapi.mdx Source changed, localizations will be marked as outdated.
en guides/content-collections.mdx Source changed, localizations will be marked as outdated.
en guides/content.mdx Source removed, will stop being tracked.
en guides/data-fetching.mdx Source changed, localizations will be marked as outdated.
en guides/deploy.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/clever-cloud.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/cloudflare.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/deno.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/flyio.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/render.mdx Source changed, localizations will be marked as outdated.
en guides/deploy/zerops.mdx Source changed, localizations will be marked as outdated.
en guides/endpoints.mdx Source changed, localizations will be marked as outdated.
en guides/environment-variables.mdx Source changed, localizations will be marked as outdated.
en guides/framework-components.mdx Source changed, localizations will be marked as outdated.
en guides/images.mdx Source changed, localizations will be marked as outdated.
en guides/imports.mdx Source changed, localizations will be marked as outdated.
en guides/integrations-guide.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/deno.mdx Source changed, localizations will be marked as outdated.
en guides/integrations-guide/lit.mdx Source changed, localizations will be marked as outdated.
en guides/integrations-guide/markdoc.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/sitemap.mdx Source changed, localizations will be marked as outdated.
en guides/integrations-guide/vercel.mdx Source changed, localizations will be marked as outdated.
en guides/internationalization.mdx Source changed, localizations will be marked as outdated.
en guides/markdown-content.mdx Source changed, localizations will be marked as outdated.
en guides/middleware.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-create-react-app.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-docusaurus.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-gatsby.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-gridsome.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-nextjs.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-nuxtjs.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-sveltekit.mdx Source changed, localizations will be marked as outdated.
en guides/migrate-to-astro/from-vuepress.mdx Source changed, localizations will be marked as outdated.
en guides/on-demand-rendering.mdx Source added, will be tracked.
en guides/routing.mdx Source changed, localizations will be marked as outdated.
en guides/rss.mdx Source changed, localizations will be marked as outdated.
en guides/server-islands.mdx Source added, will be tracked.
en guides/testing.mdx Source changed, localizations will be marked as outdated.
en guides/troubleshooting.mdx Source changed, localizations will be marked as outdated.
en guides/typescript.mdx Source changed, localizations will be marked as outdated.
en guides/upgrade-to/v2.mdx Source changed, localizations will be marked as outdated.
en guides/upgrade-to/v3.mdx Source changed, localizations will be marked as outdated.
en guides/upgrade-to/v4.mdx Source changed, localizations will be marked as outdated.
en guides/upgrade-to/v5.mdx Source added, will be tracked.
en guides/view-transitions.mdx Source changed, localizations will be marked as outdated.
en install-and-setup.mdx Source changed, localizations will be marked as outdated.
en recipes/build-forms-api.mdx Source changed, localizations will be marked as outdated.
en recipes/build-forms.mdx Source changed, localizations will be marked as outdated.
en recipes/bun.mdx Source changed, localizations will be marked as outdated.
en recipes/call-endpoints.mdx Source changed, localizations will be marked as outdated.
en recipes/captcha.mdx Source changed, localizations will be marked as outdated.
en recipes/i18n.mdx Source changed, localizations will be marked as outdated.
en recipes/sharing-state-islands.mdx Source changed, localizations will be marked as outdated.
en reference/adapter-reference.mdx Source changed, localizations will be marked as outdated.
en reference/api-reference.mdx Source changed, localizations will be marked as outdated.
en reference/cli-reference.mdx Source changed, localizations will be marked as outdated.
en reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
en reference/container-reference.mdx Source changed, localizations will be marked as outdated.
en reference/content-loader-reference.mdx Source added, will be tracked.
en reference/dev-toolbar-app-reference.mdx Source changed, localizations will be marked as outdated.
en reference/directives-reference.mdx Source changed, localizations will be marked as outdated.
en reference/error-reference.mdx Source changed, localizations will be marked as outdated.
en reference/errors/actions-without-server-output-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/adapter-support-output-mismatch.mdx Source added, will be tracked.
en reference/errors/content-collection-type-mismatch-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/content-entry-data-error.mdx Source added, will be tracked.
en reference/errors/content-loader-invalid-data-error.mdx Source added, will be tracked.
en reference/errors/content-schema-contains-slug-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/env-invalid-variables.mdx Source changed, localizations will be marked as outdated.
en reference/errors/forbidden-rewrite.mdx Source added, will be tracked.
en reference/errors/i18n-not-enabled.mdx Source changed, localizations will be marked as outdated.
en reference/errors/invalid-content-entry-data-error.mdx Source added, will be tracked.
en reference/errors/invalid-content-entry-frontmatter-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/invalid-content-entry-slug-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/locals-reassigned.mdx Source added, will be tracked.
en reference/errors/mixed-content-data-collection-error.mdx Source changed, localizations will be marked as outdated.
en reference/errors/no-adapter-installed-server-islands.mdx Source added, will be tracked.
en reference/errors/no-adapter-installed.mdx Source changed, localizations will be marked as outdated.
en reference/errors/static-client-address-not-available.mdx Source changed, localizations will be marked as outdated.
en reference/image-service-reference.mdx Source changed, localizations will be marked as outdated.
en reference/integrations-reference.mdx Source changed, localizations will be marked as outdated.
en reference/modules/astro-actions.mdx Source changed, localizations will be marked as outdated.
en reference/modules/astro-content.mdx Source changed, localizations will be marked as outdated.
en reference/modules/astro-env.mdx Source added, will be tracked.
en reference/modules/astro-transitions.mdx Source changed, localizations will be marked as outdated.
en tutorial/5-astro-api/1.mdx Source changed, localizations will be marked as outdated.
en tutorial/5-astro-api/2.mdx Source changed, localizations will be marked as outdated.
en tutorial/5-astro-api/3.mdx Source changed, localizations will be marked as outdated.
en tutorial/5-astro-api/index.mdx Source changed, localizations will be marked as outdated.
en tutorials/add-content-collections.mdx Source changed, localizations will be marked as outdated.
en tutorials/add-view-transitions.mdx Source changed, localizations will be marked as outdated.
en upgrade-astro.mdx Source changed, localizations will be marked as outdated.
es concepts/why-astro.mdx Localization changed, will be marked as complete.
es guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
es guides/cms.mdx Localization changed, will be marked as complete. 🔄️
es guides/content.mdx Localization removed, will be marked as missing.
es guides/integrations-guide/cloudflare.mdx Localization changed, will be marked as complete.
es guides/integrations-guide/netlify.mdx Localization changed, will be marked as complete.
es guides/integrations-guide/node.mdx Localization changed, will be marked as complete. 🔄️
es guides/integrations-guide/sitemap.mdx Localization changed, will be marked as complete. 🔄️
es guides/integrations-guide/vercel.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-eleventy.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-gridsome.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-hugo.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-jekyll.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-pelican.mdx Localization changed, will be marked as complete. 🔄️
es guides/migrate-to-astro/from-sveltekit.mdx Localization changed, will be marked as complete. 🔄️
es reference/configuration-reference.mdx Localization changed, will be marked as complete. 🔄️
fr concepts/why-astro.mdx Localization changed, will be marked as complete.
fr getting-started.mdx Localization changed, will be marked as complete. 🔄️
fr guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
fr guides/content-collections.mdx Localization changed, will be marked as complete. 🔄️
fr guides/content.mdx Localization removed, will be marked as missing.
fr guides/deploy/clever-cloud.mdx Localization changed, will be marked as complete. 🔄️
fr guides/integrations-guide/cloudflare.mdx Localization changed, will be marked as complete.
fr guides/integrations-guide/netlify.mdx Localization changed, will be marked as complete.
fr guides/integrations-guide/node.mdx Localization changed, will be marked as complete. 🔄️
fr guides/integrations-guide/sitemap.mdx Localization changed, will be marked as complete. 🔄️
fr guides/integrations-guide/vercel.mdx Localization changed, will be marked as complete. 🔄️
fr reference/configuration-reference.mdx Localization changed, will be marked as complete. 🔄️
fr upgrade-astro.mdx Localization changed, will be marked as complete. 🔄️
hi concepts/why-astro.mdx Localization changed, will be marked as complete.
it concepts/why-astro.mdx Localization changed, will be marked as complete.
it guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
it guides/upgrade-to/v2.mdx Localization changed, will be marked as complete.
it tutorials/add-content-collections.mdx Localization changed, will be marked as complete. 🔄️
ja basics/astro-pages.mdx Localization changed, will be marked as complete. 🔄️
ja concepts/why-astro.mdx Localization changed, will be marked as complete.
ja guides/cms.mdx Localization changed, will be marked as complete. 🔄️
ja guides/content.mdx Localization removed, will be marked as missing.
ja reference/adapter-reference.mdx Localization changed, will be marked as complete.
ko concepts/why-astro.mdx Localization changed, will be marked as complete.
ko getting-started.mdx Localization changed, will be marked as complete. 🔄️
ko guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
ko guides/content-collections.mdx Localization changed, will be marked as complete. 🔄️
ko guides/content.mdx Localization removed, will be marked as missing.
ko guides/deploy/clever-cloud.mdx Localization changed, will be marked as complete. 🔄️
ko guides/integrations-guide/cloudflare.mdx Localization changed, will be marked as complete.
ko guides/integrations-guide/netlify.mdx Localization changed, will be marked as complete.
ko guides/integrations-guide/node.mdx Localization changed, will be marked as complete. 🔄️
ko guides/integrations-guide/sitemap.mdx Localization changed, will be marked as complete. 🔄️
ko guides/integrations-guide/vercel.mdx Localization changed, will be marked as complete. 🔄️
ko reference/configuration-reference.mdx Localization changed, will be marked as complete. 🔄️
ko reference/errors/actions-without-server-output-error.mdx Localization changed, will be marked as complete.
ko upgrade-astro.mdx Localization changed, will be marked as complete. 🔄️
pl guides/content.mdx Localization removed, will be marked as missing.
pl guides/imports.mdx Localization changed, will be marked as complete. 🔄️
pl guides/upgrade-to/v2.mdx Localization changed, will be marked as complete.
pl guides/upgrade-to/v4.mdx Localization changed, will be marked as complete.
pt-br concepts/why-astro.mdx Localization changed, will be marked as complete.
pt-br guides/content.mdx Localization removed, will be marked as missing.
ru concepts/why-astro.mdx Localization changed, will be marked as complete.
ru guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
ru guides/cms.mdx Localization changed, will be marked as complete. 🔄️
ru guides/content-collections.mdx Localization changed, will be marked as complete. 🔄️
ru guides/internationalization.mdx Localization changed, will be marked as complete. 🔄️
ru guides/markdown-content.mdx Localization changed, will be marked as complete. 🔄️
ru guides/upgrade-to/v2.mdx Localization changed, will be marked as complete.
ru reference/api-reference.mdx Localization changed, will be marked as complete. 🔄️
zh-cn concepts/why-astro.mdx Localization changed, will be marked as complete.
zh-cn guides/astro-db.mdx Localization changed, will be marked as complete. 🔄️
zh-cn guides/content.mdx Localization removed, will be marked as missing.
zh-cn guides/deploy/clever-cloud.mdx Localization changed, will be marked as complete. 🔄️
zh-cn guides/integrations-guide/cloudflare.mdx Localization changed, will be marked as complete.
zh-cn guides/integrations-guide/netlify.mdx Localization changed, will be marked as complete.
zh-cn guides/integrations-guide/node.mdx Localization changed, will be marked as complete. 🔄️
zh-cn guides/integrations-guide/sitemap.mdx Localization changed, will be marked as complete. 🔄️
zh-cn guides/integrations-guide/vercel.mdx Localization changed, will be marked as complete. 🔄️
zh-cn reference/configuration-reference.mdx Localization changed, will be marked as complete. 🔄️
zh-cn reference/errors/actions-without-server-output-error.mdx Localization changed, will be marked as complete.
zh-tw concepts/why-astro.mdx Localization changed, will be marked as complete.
en nav.ts 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.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Aug 29, 2024
ematipico and others added 19 commits August 30, 2024 11:49
* feat: update `paginate()`

* Apply suggestions from code review

Co-authored-by: Chris Swithinbank <[email protected]>

---------

Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
* feat: document `Astro.routePattern`

* address feedback

* address feedback

* Apply standard API reference formatting

* Sarah's edits somehow not applied the first time?

---------

Co-authored-by: Sarah Rainsberger <[email protected]>
ArmandPhilippot and others added 9 commits November 11, 2024 09:51
* replace cookie redirect notices with a custom session guide

* add since 5.0

* add detail to guide code snippets

* add `getActionContext()` reference

* add 5.0 change

* nit: session -> sessions

* fix missing async on cookie example

* add security section

* add Since badge for 'gate actions from middleware'

* add code formatting

* replace build_hash example with session token exampel

* nit: remove unused hash variable

* change list of examples to simpler sentence

* remove stray absolute link

Co-authored-by: Armand Philippot <[email protected]>

* remove stray absolute link 2

Co-authored-by: Armand Philippot <[email protected]>

* remove stray absolute link 3

Co-authored-by: Armand Philippot <[email protected]>

* move Since to after the type def

Co-authored-by: Armand Philippot <[email protected]>

* clarify how the redirect removes the resubmission dialog

Co-authored-by: Sarah Rainsberger <[email protected]>

* reword the action return value section

Co-authored-by: Sarah Rainsberger <[email protected]>

* fix grammar

* remove misleading "reintroduces

Co-authored-by: Sarah Rainsberger <[email protected]>

* add SourcePR label

Co-authored-by: Sarah Rainsberger <[email protected]>

* nit: still -> however

Co-authored-by: Sarah Rainsberger <[email protected]>

* remove needless example of actions.blog.like

Co-authored-by: Sarah Rainsberger <[email protected]>

* rework netlify note into paragraph

* stop telling people it's easy

* reword 'Forbidden' to be near the example explanation

* rephrase 'what should I do?' to recommend sessions

* ugh

Co-authored-by: Armand Philippot <[email protected]>

* HOWEVER

Co-authored-by: Sarah Rainsberger <[email protected]>

* move SourcePR to top of change section

Co-authored-by: Sarah Rainsberger <[email protected]>

* typo fix

Co-authored-by: Armand Philippot <[email protected]>

* make reference more boring

Co-authored-by: Sarah Rainsberger <[email protected]>

* break "call this function..." to new line

Co-authored-by: Sarah Rainsberger <[email protected]>

* make action reference more boring

Co-authored-by: Sarah Rainsberger <[email protected]>

* add setActionResult example

* add deserialize use case

---------

Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0 For 5.0 stable release 5.0.0-beta i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! 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.