Skip to content

[DO] Documentation for FT and SRS GA #20757

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 28 commits into from
Closed

[DO] Documentation for FT and SRS GA #20757

wants to merge 28 commits into from

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Mar 12, 2025 •
edited
Loading

Summary

FT-related changes

  1. Consolidated the 2 partial files pertaining to DO pricing into a single file (src/content/partials/workers/storage_api_pricing.mdx and src/content/partials/workers/durable_objects_pricing.mdx have been merged into just src/content/partials/workers/durable-objects-pricing.mdx).
    • The new partial file presents pricing as a combination of compute and storage for better flow.
    • The new partial file uses conditional rendering to change the H2/H3 so that when it's called in the /workers/pricing/ page, it doesn't mess up the heading hierarchy there.
  2. Updated the pricing tables for compute billing + storage billing for DOs in the new src/content/partials/workers/durable-objects-pricing.mdx partials file.
  3. Introduced Pricing page indicating that DOs are available in both free/paid plans + explained what happens when the limit is reached, and when the limit resets.
  4. Added a "note" specifying that to downgrade, you need to first delete KV-backed namespaces.

SRS GA related changes

  1. Removed references to "Beta SQLite-storage backed DOs".
  2. Removed footnote which stated DO limit will be raised to 10 GB for GA (since this is GA now).
  3. Changed "Best practices" section into "Features". Justification: This is the approach we're implementing for D1. It also allows us to add a standalone chapter on "KV DO storage" (which may not be considered best practice, as we recommend SRS).
  4. Consolidated "Get started" into a single guide, which assumes DO will use SQLite by default. Fixed links pointing to deleted / renamed chapters, setup redirect.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun Oxyjun self-assigned this Mar 12, 2025
@Oxyjun Oxyjun marked this pull request as draft March 12, 2025 16:52
@hyperlint-ai

This comment was marked as duplicate.

Sign in to view
@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 2025 •
edited
Loading

Preview URL: https://8e2031d3.preview.developers.cloudflare.com
Preview Branch URL: https://jun-do-ft-srs-ga.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/durable-objects/get-started/tutorial-with-sql-api/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/get-started/tutorial-with-sql-api/
https://developers.cloudflare.com/durable-objects/get-started/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/get-started/
https://developers.cloudflare.com/durable-objects/platform/limits/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/platform/limits/
https://developers.cloudflare.com/durable-objects/platform/pricing/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/platform/pricing/
https://developers.cloudflare.com/durable-objects/api/storage-api/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/api/storage-api/
https://developers.cloudflare.com/durable-objects/reference/durable-objects-migrations/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/reference/durable-objects-migrations/
https://developers.cloudflare.com/browser-rendering/workers-binding-api/browser-rendering-with-do/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/browser-rendering/workers-binding-api/browser-rendering-with-do/
https://developers.cloudflare.com/durable-objects/features/access-durable-objects-storage/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/features/access-durable-objects-storage/
https://developers.cloudflare.com/durable-objects/api/state/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/api/state/
https://developers.cloudflare.com/durable-objects/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/
https://developers.cloudflare.com/workers/platform/pricing/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/workers/platform/pricing/
https://developers.cloudflare.com/durable-objects/examples/kv-storage-examples/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/examples/kv-storage-examples/
https://developers.cloudflare.com/durable-objects/api/sql-storage/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/api/sql-storage/
https://developers.cloudflare.com/durable-objects/features/websockets/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/features/websockets/
https://developers.cloudflare.com/durable-objects/get-started/ https://jun-do-ft-srs-ga.preview.developers.cloudflare.com/durable-objects/get-started/

@github-actions github-actions bot added product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product size/s labels Mar 12, 2025
@github-actions github-actions bot added size/m and removed size/s labels Mar 13, 2025
@github-actions github-actions bot added product:browser-rendering and removed product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ product:pulumi product:network product:calls product:web-analytics product:magic-cloud-networking product:workflows Workflows: https://developers.cloudflare.com/workflows/ product:key-transparency product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. product:security labels Mar 18, 2025
@KianNH KianNH force-pushed the jun/do/ft-srs-ga branch from 6882c04 to 9442780 Compare March 18, 2025 15:59
@github-actions github-actions bot removed product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:browser-rendering product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:kv labels Mar 18, 2025
@Oxyjun Oxyjun force-pushed the jun/do/ft-srs-ga branch from 9442780 to 8e2031d Compare March 18, 2025 16:10
@github-actions github-actions bot added size/l product:browser-rendering product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:kv product:queues Cloudflare Queues: https://developers.cloudflare.com/queues and removed size/xl product:pages product:d1 D1: https://developers.cloudflare.com/d1/ labels Mar 18, 2025
@Oxyjun
Copy link
Contributor Author

Oxyjun commented Mar 19, 2025

Now tracking in a clone of this PR #20938 for a cleaner PR after a bad rebase.

@Oxyjun Oxyjun closed this Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@mikenomitch mikenomitch Awaiting requested review from mikenomitch mikenomitch is a code owner

@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay ToriLindsay is a code owner

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner

@aninibread aninibread Awaiting requested review from aninibread aninibread will be requested when the pull request is marked ready for review aninibread is a code owner

@korinne korinne Awaiting requested review from korinne korinne will be requested when the pull request is marked ready for review korinne is a code owner

@jonesphillip jonesphillip Awaiting requested review from jonesphillip jonesphillip will be requested when the pull request is marked ready for review jonesphillip is a code owner

@harshil1712 harshil1712 Awaiting requested review from harshil1712 harshil1712 will be requested when the pull request is marked ready for review harshil1712 is a code owner

@mia303 mia303 Awaiting requested review from mia303 mia303 will be requested when the pull request is marked ready for review mia303 is a code owner

@thomasgauvin thomasgauvin Awaiting requested review from thomasgauvin thomasgauvin will be requested when the pull request is marked ready for review thomasgauvin is a code owner

@joshthoward joshthoward Awaiting requested review from joshthoward joshthoward will be requested when the pull request is marked ready for review joshthoward is a code owner

@sejoker sejoker Awaiting requested review from sejoker sejoker will be requested when the pull request is marked ready for review sejoker is a code owner

@mchenco mchenco Awaiting requested review from mchenco mchenco will be requested when the pull request is marked ready for review mchenco is a code owner

@celso celso Awaiting requested review from celso celso will be requested when the pull request is marked ready for review celso is a code owner

@kathayl kathayl Awaiting requested review from kathayl kathayl will be requested when the pull request is marked ready for review kathayl is a code owner

Assignees

@elithrar elithrar

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@vy-ton vy-ton

@Oxyjun Oxyjun

@ToriLindsay ToriLindsay

Labels

product:browser-rendering product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:kv product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:workers Related to Workers product size/l

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@Oxyjun @elithrar @irvinebroque @mikenomitch @GregBrimble @WalshyDev @vy-ton @ToriLindsay