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

Revamp Service Bindings docs for RPC #13252

Merged
merged 67 commits into from
Apr 5, 2024
Merged

Revamp Service Bindings docs for RPC #13252

merged 67 commits into from
Apr 5, 2024

Conversation

irvinebroque
Copy link
Contributor

@irvinebroque irvinebroque commented Mar 3, 2024

Consolidates Service binding documentation to be within the Runtime APIs section of the docs.

Screenshot 2024-03-03 at 1 30 53 PM

Currently docs for configuring a Service binding, and docs for how to write code around Service bindings are in separate sections of the docs, which makes getting started hard, requires jumping back and forth between pages. Relevant content from the configuration section has been moved here, and will be removed.

Explains what Service bindings are and what to use them for.

Screenshot 2024-03-03 at 1 31 18 PM

Provides separate code examples RPC and HTTP modes of working with Service bindings.

refs cloudflare/workerd#1658, cloudflare/workerd#1692, cloudflare/workerd#1729, cloudflare/workerd#1756, cloudflare/workerd#1757

Copy link

cloudflare-pages bot commented Mar 3, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a18829c
Status: ✅  Deploy successful!
Preview URL: https://473638f7.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev

View logs

Copy link

github-actions bot commented Mar 3, 2024

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/runtime-apis/rpc/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/
https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/rpc/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/bindings/service-bindings/rpc/
https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/lifecycle/
https://developers.cloudflare.com/workers/configuration/bindings/about-service-bindings/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/configuration/bindings/about-service-bindings/
https://developers.cloudflare.com/durable-objects/examples/build-a-counter/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/durable-objects/examples/build-a-counter/
https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/bindings/service-bindings/
https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/bindings/service-bindings/
https://developers.cloudflare.com/workers/runtime-apis/context/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/context/
https://developers.cloudflare.com/workers/runtime-apis/rpc/visibility/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/visibility/
https://developers.cloudflare.com/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/
https://developers.cloudflare.com/workers/runtime-apis/handlers/fetch/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/handlers/fetch/
https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/http/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/bindings/service-bindings/http/
https://developers.cloudflare.com/workers/runtime-apis/rpc/reserved-methods/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/reserved-methods/
https://developers.cloudflare.com/workers/runtime-apis/bindings/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/bindings/
https://developers.cloudflare.com/workers/runtime-apis/rpc/typescript/ https://bib-jsrpc-api-docs.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/typescript/

Copy link

github-actions bot commented Mar 3, 2024

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /durable-objects/configuration/access-durable-object-from-a-worker/
  • /durable-objects/configuration/create-durable-object-stubs/
  • /durable-objects/configuration/
  • /workers/configuration/bindings/about-service-bindings/

@github-actions github-actions bot added size/l product:browser-rendering product:cloudflare-for-platforms product:d1 D1: https://developers.cloudflare.com/d1/ product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ product:kv product:learning-paths product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:r2 R2 object storage: https://developers.cloudflare.com/r2 product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:workers-ai size/xl and removed size/m size/l labels Mar 3, 2024
irvinebroque and others added 2 commits April 4, 2024 19:45
* Update DO counter example with RPC
* Clarify RPC pricing
* Rename "Configuration" to "Best Practices" section
@github-actions github-actions bot added product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:queues Cloudflare Queues: https://developers.cloudflare.com/queues labels Apr 5, 2024
@irvinebroque
Copy link
Contributor Author

@elithrar for ✅ stamp so that we have it (not quite merging yet, some redirects, errors)

@irvinebroque irvinebroque changed the title [do not merge] Revamp Service Bindings docs for RPC Revamp Service Bindings docs for RPC Apr 5, 2024
@rita3ko rita3ko merged commit 3165b2d into production Apr 5, 2024
7 checks passed
@rita3ko rita3ko deleted the bib/jsrpc-api-docs branch April 5, 2024 12:05
Copy link
Contributor

Choose a reason for hiding this comment

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

(FYI @deadlypants1973 )

The content in this page (content/workers/configuration/bindings/_index.md) is now unreachable, since users will be redirected to a different page when they go to https://developers.cloudflare.com/workers/configuration/bindings/ => /workers/runtime-apis/bindings/.

If some of the content is still relevant it should be moved elsewhere. For example, the section about "dispatch namespace bindings (Workers for Platforms)" doesn't seem to be available elsewhere.

After that we should remove the _index.md and the bindings folder. However, doing this will break 70+ links in the documentation, which much also be fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for flagging — #13914

Then can remove this content and update links / redirects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pcx_team_review product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:pages product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:_redirects product:workers Related to Workers product size/xl
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet