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

Stable sessions docs #11352

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open

Stable sessions docs #11352

wants to merge 27 commits into from

Conversation

ascorbic
Copy link
Contributor

@ascorbic ascorbic commented Apr 3, 2025

Description (required)

Adds docs for the stable sessions feature:

  • removes the experimental flag page
  • adds new sessions guide
  • adds session to context API docs
  • includes the docgen output from feat: stable sessions astro#13527
  • adds info to adapter pages
  • add info on Cloudflare KV to the CF deployment guide

Related issues & labels (optional)

  • Closes #
  • Suggested label:

Copy link

netlify bot commented Apr 3, 2025

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit dd572e4
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/67f69cca0b16ac0008153ea0
😎 Deploy Preview https://deploy-preview-11352--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 Apr 3, 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/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/guides/sessions.mdx Localization added, will be marked as complete.
en/reference/api-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/error-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/errors/session-config-missing-error.mdx Source changed, localizations will be marked as outdated.
en/reference/errors/session-config-without-flag-error.mdx Source changed, localizations will be marked as outdated.
en/reference/errors/session-storage-init-error.mdx Source changed, localizations will be marked as outdated.
en/reference/errors/session-storage-save-error.mdx Source changed, localizations will be marked as outdated.
en/reference/errors/session-without-supported-adapter-output-error.mdx Source changed, localizations will be marked as outdated.
en/reference/experimental-flags/sessions.mdx Source removed, will stop being tracked.
es/reference/errors/session-config-missing-error.mdx Localization changed, will be marked as complete.
es/reference/errors/session-config-without-flag-error.mdx Localization changed, will be marked as complete.
es/reference/errors/session-storage-init-error.mdx Localization changed, will be marked as complete.
es/reference/errors/session-storage-save-error.mdx Localization changed, will be marked as complete.
fr/reference/configuration-reference.mdx Localization changed, will be marked as complete.
fr/reference/errors/session-config-missing-error.mdx Localization changed, will be marked as complete.
fr/reference/errors/session-config-without-flag-error.mdx Localization changed, will be marked as complete.
fr/reference/errors/session-storage-init-error.mdx Localization changed, will be marked as complete.
fr/reference/errors/session-storage-save-error.mdx Localization changed, will be marked as complete.
fr/reference/experimental-flags/sessions.mdx Localization removed, will be marked as missing.
ko/reference/configuration-reference.mdx Localization changed, will be marked as complete.
ko/reference/errors/session-config-missing-error.mdx Localization changed, will be marked as complete.
ko/reference/errors/session-config-without-flag-error.mdx Localization changed, will be marked as complete.
ko/reference/errors/session-storage-init-error.mdx Localization changed, will be marked as complete.
ko/reference/errors/session-storage-save-error.mdx Localization changed, will be marked as complete.
ko/reference/experimental-flags/sessions.mdx Localization removed, will be marked as missing.
pt-br/reference/errors/session-config-missing-error.mdx Localization changed, will be marked as complete.
pt-br/reference/errors/session-config-without-flag-error.mdx Localization changed, will be marked as complete.
pt-br/reference/errors/session-storage-init-error.mdx Localization changed, will be marked as complete.
pt-br/reference/errors/session-storage-save-error.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/session-config-missing-error.mdx Localization changed, will be marked as complete.
zh-cn/reference/errors/session-config-without-flag-error.mdx Localization changed, will be marked as complete.
zh-cn/reference/errors/session-storage-init-error.mdx Localization changed, will be marked as complete.
zh-cn/reference/errors/session-storage-save-error.mdx Localization changed, will be marked as complete.
zh-cn/reference/experimental-flags/sessions.mdx Localization removed, will be marked as missing.
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.

@sarah11918 sarah11918 added this to the 5.7.0 milestone Apr 3, 2025
@sarah11918
Copy link
Member

Just a reminder that we can move the API docs to config reference in this PR for internal/link consistency, but changes will (also) have to be made in the astro repo to be pulled in here. Since this is the better authoring experience, it's fine to draft the docs here, and even keep them here, for the 5.7.0 branch!

We do just have to make sure that they are eventually added to the public config types, or else we'll lose them when that file overwrites the local configuration-reference file.

@ascorbic
Copy link
Contributor Author

ascorbic commented Apr 4, 2025

@sarah11918 to be clear, these config API changes have been authored in the Astro repo, but haven't been merged as they're part of the minor PR. I ran the docgen script so they also show up here. https://github.com/withastro/astro/pull/13527/files#diff-3919010fb2f9bfd24993b91e720147659af609f7f770c14a9aab6fb2908f5fe3R934

@ascorbic ascorbic marked this pull request as ready for review April 4, 2025 10:42
@ascorbic ascorbic added minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. labels Apr 4, 2025
@ascorbic ascorbic self-assigned this Apr 4, 2025
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Apr 4, 2025
@sarah11918
Copy link
Member

Just pushed a commit to remove the translations so that the slug check should now pass!

@sarah11918
Copy link
Member

sarah11918 commented Apr 4, 2025

I believe checks should pass (or at least, shouldn't fail as a result of translations) now.

EDIT: nope! Still going...

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 submitting a partial review so far because GitHub is feeling particularly slow and unreliable! 😅

Pages still to review:

/guides/sessions.mdx
/reference/api-reference.mdx

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.

Quick light editing suggestions on the api-reference page. Looks sooooo good! Great use of the tabs!

(Next up, and finally, just the sessions guide page to review)

@sarah11918
Copy link
Member

OK @ascorbic - pushed a commit above for the API reference directly because I wanted to move headings around. (We don't need everything nexted under "basic usage" anymore because that's what this guide is now!)

At the same time, I made a few light text edits, because that's all this page needs. But, do feel free to push back on those! Was just easier with so little work needed while I was in the file anyway!

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
@sarah11918
Copy link
Member

OK @ascorbic - I think there are only two unresolved issues here now: describing the sessions object and making sure everything is version 5.7.0

I resolved the config-reference nits because I did go check the implementation PR and I think that one looks fine. I'll check it when it's pulled in here to be sure everything worked out fine, but I think it's OK as far as content goes, and I left version comments there.

@sarah11918
Copy link
Member

(Oh, and there are conflicts because the translators are translating under our feet... 😅 )

ascorbic and others added 3 commits April 8, 2025 16:05
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
@sarah11918
Copy link
Member

Noting that the Vercel additions look good! No notes! 💪

Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

Good work, here's my first pass at it. Mostly nits and a few improvements on the translations.

sarah11918 and others added 5 commits April 8, 2025 13:46
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
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.

I think that means this one is good to go, subject only to anything last minute we notice! 🎉 (And, the inevitable docgen...)

Amazing work with this Matt! Can't wait for this to be live!

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
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. 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!) 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.

6 participants