Make Compat Matrix more comprehensive #17303
Conversation
Attempts to cover all the differences between Workers and Pages
irvinebroque
requested review from
mikenomitch,
rohinlohe,
aninibread,
nevikashah and
tanushree-sharma
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
|
|
||
| <sup>1</sup> If you need to run a Worker script ahead of serving static assets, | ||
| we currently recommend using [Service | ||
| <sup>1</sup> For more details on which bindings are supported in remote development, [refer to the docs]((/workers/testing/local-development/#supported-resource-bindings-in-different-environments) |
There was a problem hiding this comment.
| <sup>1</sup> For more details on which bindings are supported in remote development, [refer to the docs]((/workers/testing/local-development/#supported-resource-bindings-in-different-environments) | |
| <sup>1</sup> For more details on which bindings are supported in remote development, [refer to the docs]((/Workers/testing/local-development/#supported-resource-bindings-in-different-environments) |
Issues:
- Style Guide - (Terms-error) Use 'Workers' instead of 'workers'.
Fix Explanation:
The term 'Workers' should be capitalized as it likely refers to a specific product or feature name, which is a common convention in technical documentation. This change aligns with the style guide's requirement for proper noun capitalization. If 'Workers' is indeed a product name, this correction is necessary to maintain consistency and clarity in the documentation. If the style guide does not currently reflect this, it may need updating to ensure all instances are treated consistently.
There was a problem hiding this comment.
We updated our model to better handle this case. Should be updated soon.
Bill, Hyperlint dev
Deploying cloudflare-docs with
|
| Latest commit: |
e600801
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://91a26856.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://bib-compat-matrix.cloudflare-docs-7ou.pages.dev |
|
Files with changes (up to 15) |
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
|
Would be good to add a legend for the table: |
|
Since scope is now more broad, should we move this up for vis into the get started guides for Workers and Pages? |
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
| | [Real-time logs](/workers/observability/logs/real-time-logs/) | ✅ | ✅ | | ||
| | **Runtime APIs & Compute Models** | | | | ||
| | [Node.js Compatibility Mode](/workers/runtime-apis/nodejs/) | ✅ | ✅ | | ||
| | [Durable Objects](/durable-objects/api/) | ✅ | 🟡 <sup>7</sup> | |
There was a problem hiding this comment.
Why is DO here? Would expect this to be under bindings
There was a problem hiding this comment.
A DO is a singleton Worker, as fundamental a compute primitive to the platform as a Worker. We need to stop treating it just as binding but as first-class compute primitive. Can move back to bindings for now from here but it is apples vs. oranges to other bindings.
@vy-ton re: framing, I think we have habit of bucketing DO with other bindings but feels different
There was a problem hiding this comment.
+1 grouping DO under Runtime APIs, DO team has #17411 (comment) to create Runtime APIs section in DO docs
|
SSL for SaaS + WFP would be good ones to add here. SSL for SaaS not supported for Pages (people need to use pages custom domains for this). WFP in progress for Workers (hoping to do this Q4) |
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Tanushree <[email protected]>
irvinebroque
requested review from
GregBrimble,
WalshyDev and
a team
as code owners
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
@tanushree-sharma maybe not in Getting Started section but yes, somewhere discoverable + I think Pages needs to explicitly link to in top-level of docs |
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/static-assets/compatibility-matrix.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Thomas Gauvin <[email protected]> Co-authored-by: Denise Peña <[email protected]>
Co-authored-by: Denise Peña <[email protected]>
| we currently recommend using [Service | ||
| <sup>1</sup> For more details on which bindings are supported in remote development, [refer to the docs](/workers/testing/local-development/#supported-resource-bindings-in-different-environments). | ||
|
|
||
| <sup>2</sup> Similar to <sup>1</sup>, to customize the HTTP headers that |
There was a problem hiding this comment.
| <sup>2</sup> Similar to <sup>1</sup>, to customize the HTTP headers that | |
| <sup>2</sup> Similar to <sup>3</sup>, to customize the HTTP headers that |
| @@ -51,22 +64,46 @@ We plan to bridge the gaps between Workers and Pages and provide ways to migrate | |||
| | [Secrets](/workers/configuration/secrets/) | ✅ | ✅ | | |||
| | [Service bindings](/workers/runtime-apis/bindings/service-bindings/) | ✅ | ✅ | | |||
| | [Vectorize](/vectorize/get-started/intro/#3-bind-your-worker-to-your-index) | ✅ | ✅ | | |||
| | **Builds (CI/CD)** | | | | |||
| | [Monorepos](/workers/ci-cd/builds/advanced-setups/) | ✅ | ✅ | | |||
| | [Build Watch Paths](/pages/configuration/build-watch-paths/) | ❌ | ✅ | | |||
No description provided.