diff --git a/COMPONENTS.md b/COMPONENTS.md index 446ac8bfd4..2925de8fd3 100644 --- a/COMPONENTS.md +++ b/COMPONENTS.md @@ -25,6 +25,7 @@ Whether you’re using core components or experimenting with new ones, this guid - [Using RelatedRead](#using-relatedread) - [Using ToolTipTerm](#using-tooltipterm) - [Using ZoomingImage](#using-zoomingimage) +- [Using ReleaseNoteHeader](#using-release-note-header) ## Finding Components @@ -375,3 +376,59 @@ Usage: ``` Images are normally stored in the '/static' folder in `img` or `diagrams`. + +## Using ReleaseNoteHeader + +Role: To provide a consistent component for adding, updating, and removing release stages on different features. + +Usage: + +In `/src/constants`, update the [`featureReleaseTypes.js`](./src/constants/featureReleaseTypes.js) file to include the release stage for the feature you want. + +Example: `serverlessWorkers: "prerelease"` + +Then on the pages you want it to show, add this to the top of the content, right below the frontmatter. The `featureName` prop is how you share the release stages you add to `featureReleaseTypes.js` across pages. + +```js +import { ReleaseNoteHeader } from '@site/src/components'; + + +``` + +Or you can choose one of these variations. + +Use the `type` prop to set a specific type if the release stage is only for one page. +```js + +``` + +Add `children` for more detailed messaging. +```js + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + +``` + +Show the supported languages by using the `languages` prop. +```js + +``` + +Use the `href` prop to make the `children` content a link. +```js + + Sign up for updates to be notified when Serverless Workers reach Public Preview. + +``` \ No newline at end of file diff --git a/bin/post-process-cli-docs.js b/bin/post-process-cli-docs.js index b8ce76c52d..1ab6dcf3ad 100755 --- a/bin/post-process-cli-docs.js +++ b/bin/post-process-cli-docs.js @@ -4,11 +4,12 @@ // // - Regenerates the command-reference index to list top-level commands // (not individual cloud subcommands). -// - Injects a pre-release admonition into cloud CLI reference pages. +// - Injects a ReleaseNoteHeader component into cloud CLI reference pages. // - Removes pages for unreleased features. // // Run after copying gen-docs output into docs/cli/command-reference/. -// When the cloud CLI reaches GA, remove the admonition block below. +// When the cloud CLI reaches GA, remove the ReleaseNoteHeader injection below +// and the "cloudCli" entry from src/constants/featureReleaseTypes.js. // When a feature ships, remove it from EXCLUDED_PAGES. const fs = require("fs"); @@ -24,12 +25,9 @@ const CMD_REF_DIR = path.join( const CLOUD_DIR = path.join(CMD_REF_DIR, "cloud"); -const ADMONITION = `:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +const IMPORT_LINE = `import { ReleaseNoteHeader } from '@site/src/components';`; -The \`temporal cloud\` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -:::`; +const COMPONENT_BLOCK = ``; const EXCLUDED_PAGES = ["custom-role.mdx"]; @@ -92,7 +90,7 @@ fs.writeFileSync(path.join(CMD_REF_DIR, "index.mdx"), indexLines.join("\n")); console.log(`[post-process] regenerated command-reference index with ${topLevelCommands.length} entries`); // --------------------------------------------------------------------------- -// 3. Inject admonition into each cloud page +// 3. Inject ReleaseNoteHeader into each cloud page // --------------------------------------------------------------------------- const cloudFiles = fs.readdirSync(CLOUD_DIR).filter((f) => f.endsWith(".mdx")); let count = 0; @@ -101,8 +99,8 @@ for (const file of cloudFiles) { const filePath = path.join(CLOUD_DIR, file); const content = fs.readFileSync(filePath, "utf-8"); - // Skip if admonition already present - if (content.includes("SUPPORT, STABILITY, and DEPENDENCY INFO")) { + // Skip if component already present + if (content.includes("ReleaseNoteHeader")) { continue; } @@ -110,19 +108,49 @@ for (const file of cloudFiles) { const marker = "*/}\n\n"; const markerIndex = content.indexOf(marker); if (markerIndex === -1) { - console.warn(`[post-process] no marker found in cloud/${file}, skipping`); + // For index.mdx and other non-generated pages, insert after frontmatter + const fmEnd = content.indexOf("---", 3); + if (fmEnd === -1) { + console.warn(`[post-process] no insertion point found in cloud/${file}, skipping`); + continue; + } + const insertAt = fmEnd + 4; // after "---\n" + const updated = + content.slice(0, insertAt) + + "\n" + + IMPORT_LINE + + "\n\n" + + COMPONENT_BLOCK + + "\n\n" + + content.slice(insertAt); + + fs.writeFileSync(filePath, updated); + count++; continue; } - const insertAt = markerIndex + marker.length; + // Insert import after frontmatter + const fmEnd = content.indexOf("---", 3); + const afterFm = fmEnd + 4; // after "---\n" + const withImport = + content.slice(0, afterFm) + + "\n" + + IMPORT_LINE + + "\n" + + content.slice(afterFm); + + // Recalculate marker position after import insertion + const newMarkerIndex = withImport.indexOf(marker); + const newInsertAt = newMarkerIndex + marker.length; + const updated = - content.slice(0, insertAt) + - ADMONITION + + withImport.slice(0, newInsertAt) + + COMPONENT_BLOCK + "\n\n" + - content.slice(insertAt); + withImport.slice(newInsertAt); fs.writeFileSync(filePath, updated); count++; } -console.log(`[post-process] injected pre-release admonition into ${count} cloud page(s)`); +console.log(`[post-process] injected ReleaseNoteHeader into ${count} cloud page(s)`); diff --git a/docs/cli/cloud.mdx b/docs/cli/cloud.mdx index 18710bb46a..bb2c154c13 100644 --- a/docs/cli/cloud.mdx +++ b/docs/cli/cloud.mdx @@ -13,6 +13,8 @@ keywords: - cloud extension --- +import { ReleaseNoteHeader } from "@site/src/components"; + The Temporal CLI works with Temporal Cloud. The same commands you use for local or self-hosted Temporal services, such as `temporal workflow start` and `temporal workflow list`, work with Temporal Cloud as allowed by your role once you provide an address and credentials. @@ -20,12 +22,7 @@ provide an address and credentials. For administrative tasks, [install the Temporal Cloud extension](/cli/setup-cli#install-the-temporal-cloud-extension). The extension adds `temporal cloud` commands for managing your Temporal Cloud account, including Namespaces, users, API keys, and Nexus endpoints. -:::tip Support, stability, and dependency info - -The Temporal Cloud extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -APIs and configuration may change before the stable release. - -::: + Access to Temporal Cloud is governed by role-based access control (RBAC). Your ability to perform actions, including running CLI commands against in Temporal Cloud is determined by the roles and permissions you have been assigned. Refer diff --git a/docs/cli/command-reference/cloud/account.mdx b/docs/cli/command-reference/cloud/account.mdx index d9e4c78fbf..817047385e 100644 --- a/docs/cli/command-reference/cloud/account.mdx +++ b/docs/cli/command-reference/cloud/account.mdx @@ -11,15 +11,12 @@ tags: - account --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/apikey.mdx b/docs/cli/command-reference/cloud/apikey.mdx index 59a8ee32e4..f68b46fded 100644 --- a/docs/cli/command-reference/cloud/apikey.mdx +++ b/docs/cli/command-reference/cloud/apikey.mdx @@ -12,15 +12,12 @@ tags: - apikeys --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud apikey` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/async-operation.mdx b/docs/cli/command-reference/cloud/async-operation.mdx index 45b4c40e29..a924af9b6c 100644 --- a/docs/cli/command-reference/cloud/async-operation.mdx +++ b/docs/cli/command-reference/cloud/async-operation.mdx @@ -12,15 +12,12 @@ tags: - async-operations --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud async-operation` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/connectivity.mdx b/docs/cli/command-reference/cloud/connectivity.mdx index 1ede6fe8ea..52ca3eac78 100644 --- a/docs/cli/command-reference/cloud/connectivity.mdx +++ b/docs/cli/command-reference/cloud/connectivity.mdx @@ -11,15 +11,12 @@ tags: - connectivity --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud connectivity` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/index.mdx b/docs/cli/command-reference/cloud/index.mdx index 2ed356f494..727464c229 100644 --- a/docs/cli/command-reference/cloud/index.mdx +++ b/docs/cli/command-reference/cloud/index.mdx @@ -13,12 +13,9 @@ tags: - Temporal CLI --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from "@site/src/components"; -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This section includes the command reference for the `temporal cloud` CLI extension. diff --git a/docs/cli/command-reference/cloud/login.mdx b/docs/cli/command-reference/cloud/login.mdx index 5bbea2c787..0a47517744 100644 --- a/docs/cli/command-reference/cloud/login.mdx +++ b/docs/cli/command-reference/cloud/login.mdx @@ -12,15 +12,12 @@ tags: - login --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud login` command. diff --git a/docs/cli/command-reference/cloud/logout.mdx b/docs/cli/command-reference/cloud/logout.mdx index dad111e13f..1cd7955eed 100644 --- a/docs/cli/command-reference/cloud/logout.mdx +++ b/docs/cli/command-reference/cloud/logout.mdx @@ -12,15 +12,12 @@ tags: - login --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud logout` command. diff --git a/docs/cli/command-reference/cloud/namespace.mdx b/docs/cli/command-reference/cloud/namespace.mdx index abdd3c333d..aec3f224ee 100644 --- a/docs/cli/command-reference/cloud/namespace.mdx +++ b/docs/cli/command-reference/cloud/namespace.mdx @@ -11,15 +11,12 @@ tags: - namespaces --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud namespace` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/nexus.mdx b/docs/cli/command-reference/cloud/nexus.mdx index a65312bc0c..ade31a1d18 100644 --- a/docs/cli/command-reference/cloud/nexus.mdx +++ b/docs/cli/command-reference/cloud/nexus.mdx @@ -10,15 +10,12 @@ tags: - nexus --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud nexus` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/region.mdx b/docs/cli/command-reference/cloud/region.mdx index 2c41d4f75b..d6d7b3738a 100644 --- a/docs/cli/command-reference/cloud/region.mdx +++ b/docs/cli/command-reference/cloud/region.mdx @@ -11,15 +11,12 @@ tags: - region --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud region` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/service-account.mdx b/docs/cli/command-reference/cloud/service-account.mdx index 6088681d39..9a6800533c 100644 --- a/docs/cli/command-reference/cloud/service-account.mdx +++ b/docs/cli/command-reference/cloud/service-account.mdx @@ -11,15 +11,12 @@ tags: - service-accounts --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud service-account` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/user-group.mdx b/docs/cli/command-reference/cloud/user-group.mdx index 00ad25a72a..abbf9d7d8c 100644 --- a/docs/cli/command-reference/cloud/user-group.mdx +++ b/docs/cli/command-reference/cloud/user-group.mdx @@ -11,15 +11,12 @@ tags: - user-groups --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud user-group` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/user.mdx b/docs/cli/command-reference/cloud/user.mdx index 97a8fc23f9..e9cd2d4004 100644 --- a/docs/cli/command-reference/cloud/user.mdx +++ b/docs/cli/command-reference/cloud/user.mdx @@ -11,15 +11,12 @@ tags: - users --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud user` commands. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand. diff --git a/docs/cli/command-reference/cloud/whoami.mdx b/docs/cli/command-reference/cloud/whoami.mdx index 139060ec42..7e61424f1d 100644 --- a/docs/cli/command-reference/cloud/whoami.mdx +++ b/docs/cli/command-reference/cloud/whoami.mdx @@ -12,15 +12,12 @@ tags: - authentication --- +import { ReleaseNoteHeader } from "@site/src/components"; + {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten. This file is generated from https://github.com/temporalio/cli via cmd/gen-docs */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporal cloud` CLI extension is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Commands and options may change before the stable release. - -::: + This page provides a reference for the `temporal cloud whoami` command. diff --git a/docs/cloud/billing-and-usage/billing-api.mdx b/docs/cloud/billing-and-usage/billing-api.mdx index f8626b46dd..f58f494ec7 100644 --- a/docs/cloud/billing-and-usage/billing-api.mdx +++ b/docs/cloud/billing-and-usage/billing-api.mdx @@ -13,17 +13,17 @@ tags: - Temporal Cloud --- +import { ReleaseNoteHeader } from '@site/src/components'; + + + The Temporal Cloud Billing API provides Namespace-level cost attribution through on-demand billing reports. Reports are delivered in CSV format and can be accessed via API or downloaded directly for use in FinOps tooling and cost management platforms. This API is part of the [Cloud Operations API](/ops). -:::tip Support, stability, and dependency info - -The Temporal Cloud Billing API is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: - The Billing API allows you to: - Generate billing reports for specified invoice months diff --git a/docs/cloud/billing-and-usage/index.mdx b/docs/cloud/billing-and-usage/index.mdx index 95df2a9556..e440261dcb 100644 --- a/docs/cloud/billing-and-usage/index.mdx +++ b/docs/cloud/billing-and-usage/index.mdx @@ -21,8 +21,7 @@ tags: - Temporal Cloud --- -import * as Components from '@site/src/components'; - +import { ReleaseNoteHeader } from '@site/src/components'; Temporal Cloud provides billing and costs information for your account. Use this information to assess your spending patterns, inspect your credit ledger, @@ -40,13 +39,11 @@ The following tools are available for measuring Usage and Billing: - Viewable by Account Owners and Finance Admin - **[Billing API](/cloud/billing-api):** Allows you to access billing information on a Namespace basis down to an hourly granularity, enriched with Tags and Projects. The Billing API provides a FOCUS-guided data format that can be ingested into your cloud cost management platform or analytics tooling. - - Viewable by Account Owners and Finance Admin - -:::tip Support, stability, and dependency info - -The Temporal Cloud Billing API is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). + - Viewable by Account Owners and Finance Admin -::: + - **[Usage Dashboards](/cloud/actions-usage):** Aggregate Actions on a Namespace level and includes Action categories that groups similar types of Actions as seen in [Actions](/cloud/actions). Available in the Cloud UI in the usage dashboard and Namespace overview pages. - Viewable by Account Owners, Finance Admin, Global Admin on an account level. Namespace level usage is visible on the Namespace pages to those with access. @@ -57,9 +54,6 @@ The Temporal Cloud Billing API is in [Public Preview](/evaluate/development-prod - **[Actions Metrics](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_billable_action_count):** A high cardinality billable action metric that include labels for Category, Action Type, Workflow Type and Namespace down to minute granularity. - Viewable by creating a service account with the "Metrics Read-Only" role. See the [OpenMetrics](/cloud/metrics/openmetrics#api-key-authentication) page for more information. -:::tip Support, stability, and dependency info - -Temporal Cloud Action Metrics is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: - + \ No newline at end of file diff --git a/docs/cloud/migrate/automated.mdx b/docs/cloud/migrate/automated.mdx index 8fd46abcf8..6fcb562156 100644 --- a/docs/cloud/migrate/automated.mdx +++ b/docs/cloud/migrate/automated.mdx @@ -18,12 +18,11 @@ tags: - Production --- -:::tip Support, stability, and dependency info +import { ReleaseNoteHeader } from '@site/src/components'; -Automated migration is currently in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -Please contact your Temporal account executive prior to planning your migration project. - -::: + + Please contact your Temporal account executive prior to planning your migration project. + ## Process Overview diff --git a/docs/cloud/nexus/index.mdx b/docs/cloud/nexus/index.mdx index e287d7c1b3..e8245b3110 100644 --- a/docs/cloud/nexus/index.mdx +++ b/docs/cloud/nexus/index.mdx @@ -25,13 +25,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). -Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Temporal Cloud builds on the [core Nexus experience](/nexus) with: - **Global [Nexus Registry](/nexus/registry)** - Scoped to your entire Account across all Namespaces. Workers in any Namespace can host Nexus Services for others to use. diff --git a/docs/cloud/nexus/latency-availability.mdx b/docs/cloud/nexus/latency-availability.mdx index 7da8a3ee23..eab78dd106 100644 --- a/docs/cloud/nexus/latency-availability.mdx +++ b/docs/cloud/nexus/latency-availability.mdx @@ -20,13 +20,6 @@ keywords: - service level agreement --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). -Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Nexus latency and availability in Temporal Cloud: - **SLOs and SLAs** - Nexus operations (for example, `RespondWorkflowTaskCompleted`, `PollNexusTaskQueue`, `RespondNexusTaskCompleted`, and `RespondNexusTaskFailed`) have the same [latency SLOs](/cloud/service-availability#latency) and [availability SLAs](/cloud/sla) as other Worker requests in both caller and handler Namespaces. diff --git a/docs/cloud/nexus/limits.mdx b/docs/cloud/nexus/limits.mdx index ae5aa96c21..6027318ae1 100644 --- a/docs/cloud/nexus/limits.mdx +++ b/docs/cloud/nexus/limits.mdx @@ -18,13 +18,6 @@ keywords: - max operation duration --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). -Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Nexus limits are documented in [Temporal Cloud limits](/cloud/limits): - [Nexus rate limits](/cloud/limits#nexus-rate-limits) - Nexus requests count toward the Namespace RPS limit. diff --git a/docs/cloud/nexus/observability.mdx b/docs/cloud/nexus/observability.mdx index 7344a60bb7..5f910fb35e 100644 --- a/docs/cloud/nexus/observability.mdx +++ b/docs/cloud/nexus/observability.mdx @@ -17,14 +17,6 @@ keywords: - audit log streaming --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now -[Generally Available](/evaluate/development-production-features/release-stages#general-availability). Learn why you -should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Nexus observability in Temporal Cloud: - **[Nexus metrics](/nexus/metrics)** - [SDK metrics](/nexus/metrics#sdk-metrics) emitted by Workers and [Cloud metrics](/nexus/metrics#cloud-metrics) emitted by Temporal Cloud. diff --git a/docs/cloud/nexus/pricing.mdx b/docs/cloud/nexus/pricing.mdx index 785d9b4227..53bdf1eb23 100644 --- a/docs/cloud/nexus/pricing.mdx +++ b/docs/cloud/nexus/pricing.mdx @@ -13,13 +13,6 @@ keywords: - Temporal Cloud pricing --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). -Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Nexus pricing: - **One Action to start or cancel a Nexus Operation** in the caller Namespace. diff --git a/docs/cloud/nexus/security.mdx b/docs/cloud/nexus/security.mdx index cfab97c6e3..6541f7f768 100644 --- a/docs/cloud/nexus/security.mdx +++ b/docs/cloud/nexus/security.mdx @@ -14,13 +14,6 @@ keywords: - access control --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). -Learn why you should use Nexus in the [evaluation guide](/evaluate/nexus). - -::: - Nexus security in Temporal Cloud: - **[Runtime access controls](/nexus/security#runtime-access-controls)** - Endpoint allowlists restrict which caller Namespaces can use an Endpoint. See [configuring access controls](/nexus/registry#configure-runtime-access-controls). diff --git a/docs/cloud/operation-api.mdx b/docs/cloud/operation-api.mdx index 1369fbe710..1e7dcd3923 100644 --- a/docs/cloud/operation-api.mdx +++ b/docs/cloud/operation-api.mdx @@ -12,11 +12,11 @@ tags: - Temporal Cloud --- -:::tip Support, stability, and dependency info +import { ReleaseNoteHeader } from '@site/src/components'; -The Temporal Cloud Operations API is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + The Temporal Cloud Operations API, or the Cloud Ops API, is an open source, public [HTTP API](https://saas-api.tmprl.cloud/docs/httpapi.html#description/introduction) and [gRPC API](https://github.com/temporalio/cloud-api/tree/main) for programmatically managing Temporal Cloud Control Plane resources, including [Namespaces](/cloud/namespaces), [Users](/cloud/users), [Service Accounts](/cloud/service-accounts), [API keys](/cloud/api-keys), and others. The Temporal Cloud [Terraform Provider](/cloud/terraform-provider), [tcld CLI](/cloud/tcld), and Web UI all use the Cloud Ops API. diff --git a/docs/cloud/worker-health.mdx b/docs/cloud/worker-health.mdx index 22fe1873eb..7a0bfb8c9b 100644 --- a/docs/cloud/worker-health.mdx +++ b/docs/cloud/worker-health.mdx @@ -28,6 +28,7 @@ keywords: --- import { LANGUAGE_TAB_GROUP, getLanguageLabel } from '@site/src/constants/languageTabs'; import SdkTabs from '@site/src/components'; +import { ReleaseNoteHeader } from '@site/src/components'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -377,11 +378,9 @@ rate(temporal_sticky_cache_total_forced_eviction_total{namespace="$namespace"}[5 ## Manage Worker Heartbeating {/* #manage-worker-heartbeating */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -This feature is currently in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Workers send a heartbeat to Temporal Server every 60 seconds by default. This heartbeat serves to provide liveness and configuration data from the Worker to the Server. Specific data sent can be found in the [API](https://github.com/temporalio/api/blob/main/temporal/api/worker/v1/message.proto). By providing a consistent heartbeat from diff --git a/docs/develop/dotnet/activities/standalone-activities.mdx b/docs/develop/dotnet/activities/standalone-activities.mdx index a12f803c62..0fc8ba29e6 100644 --- a/docs/develop/dotnet/activities/standalone-activities.mdx +++ b/docs/develop/dotnet/activities/standalone-activities.mdx @@ -19,12 +19,11 @@ tags: description: Execute Activities independently without a Workflow using the Temporal .NET SDK. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Temporal .NET SDK support for [Standalone Activities](/standalone-activity) is at -[Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Standalone Activities are Activities that run independently, without being orchestrated by a Workflow. Instead of starting an Activity from within a Workflow Definition, you start a Standalone diff --git a/docs/develop/dotnet/nexus/feature-guide.mdx b/docs/develop/dotnet/nexus/feature-guide.mdx index c874b7b7a5..02025bf94b 100644 --- a/docs/develop/dotnet/nexus/feature-guide.mdx +++ b/docs/develop/dotnet/nexus/feature-guide.mdx @@ -14,13 +14,11 @@ tags: - .NET SDK --- -import { CaptionedImage } from '@site/src/components'; +import { CaptionedImage, ReleaseNoteHeader } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal .NET SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. diff --git a/docs/develop/dotnet/nexus/index.mdx b/docs/develop/dotnet/nexus/index.mdx index ddfdb493c3..73f10b5d53 100644 --- a/docs/develop/dotnet/nexus/index.mdx +++ b/docs/develop/dotnet/nexus/index.mdx @@ -11,13 +11,11 @@ tags: - Temporal SDKs --- -import * as Components from '@site/src/components'; +import { ReleaseNoteHeader } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal .NET SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + ![.NET SDK Banner](/img/assets/banner-dotnet-temporal.png) diff --git a/docs/develop/dotnet/nexus/quickstart.mdx b/docs/develop/dotnet/nexus/quickstart.mdx index 4c56a4176c..f1f0fb6940 100644 --- a/docs/develop/dotnet/nexus/quickstart.mdx +++ b/docs/develop/dotnet/nexus/quickstart.mdx @@ -17,14 +17,11 @@ hide_table_of_contents: true --- import { SetupSteps, SetupStep, CodeSnippet } from '@site/src/components/elements/SetupSteps'; +import { ReleaseNoteHeader } from '@site/src/components'; -# Nexus .NET Quickstart - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal .NET SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + [Temporal Nexus](/evaluate/nexus) connects Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. Build a Nexus Service that wraps an existing Temporal Workflow, then invoke it from a caller Workflow. diff --git a/docs/develop/go/activities/standalone-activities.mdx b/docs/develop/go/activities/standalone-activities.mdx index 1cbd835026..abdf160ade 100644 --- a/docs/develop/go/activities/standalone-activities.mdx +++ b/docs/develop/go/activities/standalone-activities.mdx @@ -19,12 +19,11 @@ tags: description: Execute Activities independently without a Workflow using the Temporal Go SDK. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Temporal Go SDK support for [Standalone Activities](/standalone-activity) is at -[Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Standalone Activities are Activity Executions that run independently, without being orchestrated by a Workflow. Instead of starting an Activity from within a Workflow Definition using `workflow.ExecuteActivity()`, you start a Standalone diff --git a/docs/develop/go/nexus/feature-guide.mdx b/docs/develop/go/nexus/feature-guide.mdx index d0bcc88493..c06718906d 100644 --- a/docs/develop/go/nexus/feature-guide.mdx +++ b/docs/develop/go/nexus/feature-guide.mdx @@ -18,12 +18,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Go SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. This page shows how to do the following: diff --git a/docs/develop/go/nexus/index.mdx b/docs/develop/go/nexus/index.mdx index 4d5c5fcdc9..4dffdd4389 100644 --- a/docs/develop/go/nexus/index.mdx +++ b/docs/develop/go/nexus/index.mdx @@ -11,14 +11,6 @@ tags: - Temporal SDKs --- -import * as Components from '@site/src/components'; - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Go SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - ![Go SDK Banner](/img/assets/banner-go-temporal.png) ## Temporal Nexus diff --git a/docs/develop/go/nexus/quickstart.mdx b/docs/develop/go/nexus/quickstart.mdx index 4065f56e0b..684f2a9f82 100644 --- a/docs/develop/go/nexus/quickstart.mdx +++ b/docs/develop/go/nexus/quickstart.mdx @@ -20,12 +20,6 @@ import { SetupSteps, SetupStep, CodeSnippet } from '@site/src/components/element # Nexus Go Quickstart -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Go SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - [Temporal Nexus](/evaluate/nexus) connects Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. Build a Nexus Service that wraps an existing Temporal Workflow, then invoke it from a caller Workflow. :::info NEW TO NEXUS? diff --git a/docs/develop/go/workers/serverless-workers/aws-lambda.mdx b/docs/develop/go/workers/serverless-workers/aws-lambda.mdx index ca8da50d95..d0414bb3c2 100644 --- a/docs/develop/go/workers/serverless-workers/aws-lambda.mdx +++ b/docs/develop/go/workers/serverless-workers/aws-lambda.mdx @@ -19,14 +19,13 @@ tags: - AWS Lambda --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + The `lambdaworker` package lets you run a Temporal Serverless Worker on AWS Lambda. Deploy your Worker code as a Lambda function, and Temporal Cloud invokes it when Tasks arrive. diff --git a/docs/develop/go/workers/sessions.mdx b/docs/develop/go/workers/sessions.mdx index 407a4bb638..6b74a23628 100644 --- a/docs/develop/go/workers/sessions.mdx +++ b/docs/develop/go/workers/sessions.mdx @@ -18,9 +18,9 @@ This page shows how to do the following: - [Change the maximum concurrent Sessions of a Worker](#max-concurrent-sessions) - [Create a Worker Session](#create-a-session) -:::tip Support, stability, and dependency info +:::tip -- This feature is currently available only in the Go SDK. +This feature is currently available only in the Go SDK. ::: diff --git a/docs/develop/java/activities/standalone-activities.mdx b/docs/develop/java/activities/standalone-activities.mdx index c56a6a1bfc..c56b3061fe 100644 --- a/docs/develop/java/activities/standalone-activities.mdx +++ b/docs/develop/java/activities/standalone-activities.mdx @@ -19,14 +19,13 @@ tags: description: Execute Activities independently without a Workflow using the Temporal Java SDK. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Temporal Java SDK support for [Standalone Activities](/standalone-activity) is at -[Pre-release](/evaluate/development-production-features/release-stages#pre-release). + -::: - -Standalone Activities are Activities that run independently, without being orchestrated by a +[Standalone Activities](/standalone-activity) are Activities that run independently, without being orchestrated by a Workflow. Instead of starting an Activity from within a Workflow Definition, you start a Standalone Activity directly from a Temporal Client using `ActivityClient`. diff --git a/docs/develop/java/nexus/feature-guide.mdx b/docs/develop/java/nexus/feature-guide.mdx index 39e75973e3..d94e7fdbb6 100644 --- a/docs/develop/java/nexus/feature-guide.mdx +++ b/docs/develop/java/nexus/feature-guide.mdx @@ -17,13 +17,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Java SDK support for Nexus is -[Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. diff --git a/docs/develop/java/nexus/index.mdx b/docs/develop/java/nexus/index.mdx index 2246063f16..b67cb7d048 100644 --- a/docs/develop/java/nexus/index.mdx +++ b/docs/develop/java/nexus/index.mdx @@ -11,14 +11,6 @@ tags: - Temporal SDKs --- -import * as Components from '@site/src/components'; - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Java SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - ![Java SDK Banner](/img/assets/banner-java-temporal.png) ## Temporal Nexus diff --git a/docs/develop/java/nexus/quickstart.mdx b/docs/develop/java/nexus/quickstart.mdx index 78bcb7e159..8ea5008f49 100644 --- a/docs/develop/java/nexus/quickstart.mdx +++ b/docs/develop/java/nexus/quickstart.mdx @@ -18,14 +18,6 @@ hide_table_of_contents: true import { SetupSteps, SetupStep, CodeSnippet } from '@site/src/components/elements/SetupSteps'; -# Nexus Java Quickstart - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Java SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - [Temporal Nexus](/evaluate/nexus) connects Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. Build a Nexus Service that wraps an existing Temporal Workflow, then invoke it from a caller Workflow. :::info NEW TO NEXUS? diff --git a/docs/develop/python/activities/standalone-activities.mdx b/docs/develop/python/activities/standalone-activities.mdx index 724e127d2c..627bb46c88 100644 --- a/docs/develop/python/activities/standalone-activities.mdx +++ b/docs/develop/python/activities/standalone-activities.mdx @@ -19,12 +19,12 @@ tags: description: Execute Activities independently without a Workflow using the Temporal Python SDK. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Temporal Python SDK support for [Standalone Activities](/standalone-activity) is at -[Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Standalone Activities are Activities that run independently, without being orchestrated by a Workflow. Instead of starting an Activity from within a Workflow Definition, you start a Standalone diff --git a/docs/develop/python/integrations/langsmith.mdx b/docs/develop/python/integrations/langsmith.mdx index 62f1194cac..d005279c5f 100644 --- a/docs/develop/python/integrations/langsmith.mdx +++ b/docs/develop/python/integrations/langsmith.mdx @@ -17,6 +17,12 @@ description: Add LangSmith tracing to Python Workflows using the Temporal Python SDK. --- +import { ReleaseNoteHeader } from '@site/src/components'; + + + All APIs are experimental and may be subject to backwards-incompatible changes. + + Temporal's LangSmith integration lets you trace AI agent Workflows in [LangSmith](https://smith.langchain.com/) alongside every LLM call, tool execution, and Temporal operation. @@ -28,15 +34,6 @@ The `LangSmithPlugin` is what connects the two. It propagates trace context acro started on the Client nest correctly under Workflow and Activity runs on the Worker. It can also create LangSmith runs for Temporal operations themselves: Workflow executions, Activity executions, Signals, Updates, and Queries. -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Python SDK support for LangSmith is at -[Pre-release](/evaluate/development-production-features/release-stages#pre-release). - -All APIs are experimental and may be subject to backwards-incompatible changes. - -::: - All code snippets in this guide are taken from the [LangSmith tracing sample](https://github.com/temporalio/samples-python/tree/main/langsmith_tracing). Refer to the sample for complete code. diff --git a/docs/develop/python/nexus/feature-guide.mdx b/docs/develop/python/nexus/feature-guide.mdx index f484adefa2..e037be3e4e 100644 --- a/docs/develop/python/nexus/feature-guide.mdx +++ b/docs/develop/python/nexus/feature-guide.mdx @@ -17,12 +17,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Python SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. This page shows how to do the following: diff --git a/docs/develop/python/nexus/index.mdx b/docs/develop/python/nexus/index.mdx index bb4b354fcf..c5783cb3dd 100644 --- a/docs/develop/python/nexus/index.mdx +++ b/docs/develop/python/nexus/index.mdx @@ -13,12 +13,6 @@ tags: import * as Components from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Python SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - ![Python SDK Banner](/img/assets/banner-python-temporal.png) ## Temporal Nexus diff --git a/docs/develop/python/nexus/quickstart.mdx b/docs/develop/python/nexus/quickstart.mdx index d26359bf21..0c731c0037 100644 --- a/docs/develop/python/nexus/quickstart.mdx +++ b/docs/develop/python/nexus/quickstart.mdx @@ -20,12 +20,6 @@ import { SetupSteps, SetupStep, CodeSnippet } from '@site/src/components/element # Nexus Python Quickstart -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Python SDK support for Nexus is [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - [Temporal Nexus](/evaluate/nexus) connects Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. Build a Nexus Service that wraps an existing Temporal Workflow, then invoke it from a caller Workflow. :::info NEW TO NEXUS? diff --git a/docs/develop/python/workers/serverless-workers/aws-lambda.mdx b/docs/develop/python/workers/serverless-workers/aws-lambda.mdx index b8879da487..b693015c76 100644 --- a/docs/develop/python/workers/serverless-workers/aws-lambda.mdx +++ b/docs/develop/python/workers/serverless-workers/aws-lambda.mdx @@ -19,14 +19,13 @@ tags: - AWS Lambda --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + The `lambda_worker` contrib package lets you run a Temporal Serverless Worker on AWS Lambda. Deploy your Worker code as a Lambda function, and Temporal Cloud invokes it when Tasks arrive. diff --git a/docs/develop/python/workflows/workflow-streams.mdx b/docs/develop/python/workflows/workflow-streams.mdx index eabccd27ed..215909c5fb 100644 --- a/docs/develop/python/workflows/workflow-streams.mdx +++ b/docs/develop/python/workflows/workflow-streams.mdx @@ -19,6 +19,12 @@ tags: description: Stream events from a Workflow to subscribers using the Temporal Python SDK Workflow Streams contrib module. --- +import { ReleaseNoteHeader } from '@site/src/components'; + + + **Workflow Streams** is a Temporal Python SDK `contrib` library that gives a Workflow a durable, offset-addressed event channel built on Temporal's basic message primitives: Signals, Updates, and Queries. It batch-publishes events to amortize per-Signal cost, deduplicates batches for exactly-once delivery to the log, supports topic filtering, and carries state across Continue-As-New for long-running streams. @@ -26,18 +32,6 @@ Use Workflow Streams when you want outside observers to follow the progress of a The Workflow hosts the event log. Publishers append events — the Workflow itself, Activities, or external processes via `WorkflowStreamClient`. Subscribers attach to the Workflow ID, optionally filter by **topic** (a string label set when publishing; topics are implicit and created on first publish), and consume events by long-polling from an offset they store. -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -The `temporalio.contrib.workflow_streams` module is currently in -[Public Preview](/evaluate/development-production-features/release-stages#public-preview). Refer to the -[Temporal product release stages guide](/evaluate/development-production-features/release-stages) for more information. - -Cross-language client support is on the roadmap. Only the Python client is available today. - -The API may change before general availability. - -::: - **Looking for...** - Runnable end-to-end samples (basic publish/subscribe, reconnecting subscriber, external publisher, bounded log): [Workflow Streams samples](https://github.com/temporalio/samples-python/tree/main/workflow_streams). diff --git a/docs/develop/typescript/activities/standalone-activities.mdx b/docs/develop/typescript/activities/standalone-activities.mdx index 04f6934bef..e39d989500 100644 --- a/docs/develop/typescript/activities/standalone-activities.mdx +++ b/docs/develop/typescript/activities/standalone-activities.mdx @@ -19,12 +19,11 @@ tags: description: Execute Activities independently without a Workflow using the Temporal TypeScript SDK. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Temporal TypeScript SDK support for [Standalone Activities](/standalone-activity) is at -[Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Standalone Activities are Activities that run independently, without being orchestrated by a Workflow. Instead of starting an Activity from within a Workflow Definition, you start a Standalone diff --git a/docs/develop/typescript/nexus/feature-guide.mdx b/docs/develop/typescript/nexus/feature-guide.mdx index fab225ac12..256914ec2f 100644 --- a/docs/develop/typescript/nexus/feature-guide.mdx +++ b/docs/develop/typescript/nexus/feature-guide.mdx @@ -14,13 +14,11 @@ tags: - TypeScript SDK --- -import { CaptionedImage } from "@site/src/components"; +import { CaptionedImage, ReleaseNoteHeader } from "@site/src/components"; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal TypeScript SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + Use [Temporal Nexus](/evaluate/nexus) to connect Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. diff --git a/docs/develop/typescript/nexus/index.mdx b/docs/develop/typescript/nexus/index.mdx index 16ce4c9921..85352c2695 100644 --- a/docs/develop/typescript/nexus/index.mdx +++ b/docs/develop/typescript/nexus/index.mdx @@ -12,13 +12,11 @@ tags: - Temporal SDKs --- -import * as Components from '@site/src/components'; +import { ReleaseNoteHeader } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal TypeScript SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + ![TypeScript SDK Banner](/img/assets/banner-typescript-temporal.png) diff --git a/docs/develop/typescript/nexus/quickstart.mdx b/docs/develop/typescript/nexus/quickstart.mdx index 035ce3f9b0..aa565ed383 100644 --- a/docs/develop/typescript/nexus/quickstart.mdx +++ b/docs/develop/typescript/nexus/quickstart.mdx @@ -17,14 +17,11 @@ hide_table_of_contents: true --- import { SetupSteps, SetupStep, CodeSnippet } from '@site/src/components/elements/SetupSteps'; +import { ReleaseNoteHeader } from '@site/src/components'; -# Nexus TypeScript Quickstart - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal TypeScript SDK support for Nexus is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - -::: + [Temporal Nexus](/evaluate/nexus) connects Temporal Applications within and across Namespaces using a Nexus Endpoint, a Nexus Service contract, and Nexus Operations. Build a Nexus Service that wraps an existing Temporal Workflow, then invoke it from a caller Workflow. diff --git a/docs/develop/typescript/workers/serverless-workers/aws-lambda.mdx b/docs/develop/typescript/workers/serverless-workers/aws-lambda.mdx index cff408b608..f5d231b116 100644 --- a/docs/develop/typescript/workers/serverless-workers/aws-lambda.mdx +++ b/docs/develop/typescript/workers/serverless-workers/aws-lambda.mdx @@ -19,14 +19,13 @@ tags: - AWS Lambda --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + The `@temporalio/lambda-worker` package lets you run a Temporal Serverless Worker on AWS Lambda. Deploy your Worker code as a Lambda function, and Temporal Cloud invokes it when Tasks arrive. diff --git a/docs/develop/worker-performance.mdx b/docs/develop/worker-performance.mdx index 4423a8ed7c..432449e174 100644 --- a/docs/develop/worker-performance.mdx +++ b/docs/develop/worker-performance.mdx @@ -9,7 +9,7 @@ tags: - Performance --- -import { CaptionedImage } from '@site/src/components'; +import { CaptionedImage, ReleaseNoteHeader } from '@site/src/components'; import { LANGUAGE_TAB_GROUP, getLanguageLabel } from '@site/src/constants/languageTabs'; import SdkTabs from '@site/src/components'; @@ -124,12 +124,9 @@ If it does, it may try to reserve an Activity Slot for the execution of the Acti #### Eager Workflow Start -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Eager Workflow Start is available in [Public Preview](/evaluate/development-production-features/release-stages#public-preview) in the Go, Java, Python, and .NET SDKs. -Eager Workflow Start is enabled for all Temporal Cloud users and self-hosted Temporal Server 1.29.0+. No additional configuration or access request is needed. However, you must set Request-Eager-Start to true when starting each Workflow for Eager Workflow Start to be used. - -::: + + Eager Workflow Start is enabled for all Temporal Cloud users and self-hosted Temporal Server 1.29.0+. No additional configuration or access request is needed. However, you must set `Request-Eager-Start` to true when starting each Workflow for Eager Workflow Start to be used. + Eager Workflow Start reduces the latency required to initiate a Workflow execution. It is recommended for short-lived Workflows that use Local Activities to interact with external services, especially when these interactions are initiated in the first Workflow Task and the Workflow is deployed near the Temporal Server to minimize network delay. @@ -692,7 +689,7 @@ The `maxWorkflowThreadCount` and `workflow_active_thread_count` parameters are f ## Available Task Queue information {/* #task-queue-metrics */} -:::tip Support, stability, and dependency info +:::info The information listed in this section is readable using the `DescribeTaskQueueEnhanced` method in the [Go SDK](https://github.com/temporalio/sdk-go/blob/74320648ab0e4178b1fedde01672f9b5b9f6c898/client/client.go), with the [Temporal CLI](https://github.com/temporalio/cli/releases/tag/v1.1.0) `task-queue describe` command, and using `DescribeTaskQueue` through RPC. diff --git a/docs/encyclopedia/activities/standalone-activity.mdx b/docs/encyclopedia/activities/standalone-activity.mdx index 5ec759a2be..3847a4b231 100644 --- a/docs/encyclopedia/activities/standalone-activity.mdx +++ b/docs/encyclopedia/activities/standalone-activity.mdx @@ -17,12 +17,14 @@ tags: --- import ThemedImage from '@theme/ThemedImage'; - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Standalone Activities are available as a [Public Preview](/evaluate/development-production-features/release-stages#public-preview) feature in [Temporal Cloud](#temporal-cloud-support) and in the [Temporal CLI](#temporal-cli-support) v1.7.0 or higher with Temporal Server v1.31.0 or higher. - -::: +import { ReleaseNoteHeader } from '@site/src/components'; + + + Available in in [Temporal Cloud](#temporal-cloud-support) and in the [Temporal CLI](#temporal-cli-support) v1.7.0 or higher with Temporal Server v1.31.0 or higher. + See [limitations](#public-preview-limitations) below. diff --git a/docs/encyclopedia/nexus/nexus-endpoints.mdx b/docs/encyclopedia/nexus/nexus-endpoints.mdx index e4e97471db..85517a22d2 100644 --- a/docs/encyclopedia/nexus/nexus-endpoints.mdx +++ b/docs/encyclopedia/nexus/nexus-endpoints.mdx @@ -16,12 +16,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - A [Nexus Endpoint](/glossary#nexus-endpoint) is a fully managed reverse proxy for [Nexus Services](/nexus/services). It routes requests from a caller Workflow to a target Namespace and Task Queue. Callers only need to know the Endpoint name - the target Namespace, Task Queue, and internal implementation are encapsulated. diff --git a/docs/encyclopedia/nexus/nexus-error-handling.mdx b/docs/encyclopedia/nexus/nexus-error-handling.mdx index 26c96e2d09..87bcd1c399 100644 --- a/docs/encyclopedia/nexus/nexus-error-handling.mdx +++ b/docs/encyclopedia/nexus/nexus-error-handling.mdx @@ -15,12 +15,6 @@ tags: - Nexus --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - Nexus Operations can return errors for a caller Workflow to handle. Errors from an asynchronous Operation's underlying Workflow propagate back to the caller. diff --git a/docs/encyclopedia/nexus/nexus-execution-debugging.mdx b/docs/encyclopedia/nexus/nexus-execution-debugging.mdx index 05cf6a181c..142c080fbd 100644 --- a/docs/encyclopedia/nexus/nexus-execution-debugging.mdx +++ b/docs/encyclopedia/nexus/nexus-execution-debugging.mdx @@ -15,12 +15,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - Nexus supports end-to-end execution debugging across caller Workflows, Nexus Operations, and handler Workflows - even across [multi-level calls](/nexus#multi-level-calls) spanning multiple Namespaces. diff --git a/docs/encyclopedia/nexus/nexus-metrics.mdx b/docs/encyclopedia/nexus/nexus-metrics.mdx index fbc8b38f40..ea27de5249 100644 --- a/docs/encyclopedia/nexus/nexus-metrics.mdx +++ b/docs/encyclopedia/nexus/nexus-metrics.mdx @@ -17,13 +17,6 @@ keywords: - nexus oss metrics --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - - Nexus provides SDK metrics, Cloud metrics, and OSS Cluster metrics in addition to integrated [execution debugging](/nexus/execution-debugging). ## SDK Metrics diff --git a/docs/encyclopedia/nexus/nexus-operations.mdx b/docs/encyclopedia/nexus/nexus-operations.mdx index a2e5be6be2..cb307dc67c 100644 --- a/docs/encyclopedia/nexus/nexus-operations.mdx +++ b/docs/encyclopedia/nexus/nexus-operations.mdx @@ -31,12 +31,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - [Nexus Operations](/glossary#nexus-operation) can be synchronous or asynchronous. Unlike a traditional RPC, an asynchronous Nexus Operation has an operation token that can be used to re-attach to a long-running Operation backed by a Workflow. An Operation's lifecycle spans scheduling, reliable delivery with retries, handler execution, and result or callback completion. diff --git a/docs/encyclopedia/nexus/nexus-patterns.mdx b/docs/encyclopedia/nexus/nexus-patterns.mdx index b2a308f3b6..2825b12239 100644 --- a/docs/encyclopedia/nexus/nexus-patterns.mdx +++ b/docs/encyclopedia/nexus/nexus-patterns.mdx @@ -17,12 +17,6 @@ tags: - Concepts --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - There are two common patterns for building and deploying [Nexus Services](/nexus/services): - **[Collocated pattern](#collocated-pattern)**: Runs on the same Workers as your existing Workflows and Activities. Use by default. - **[Router pattern](#router-queue-pattern)**: Separates Nexus routing from Workflow execution. A dedicated Nexus Worker on a “router” Task Queue routes Operations to Workflows on other Task Queues. diff --git a/docs/encyclopedia/nexus/nexus-registry.mdx b/docs/encyclopedia/nexus/nexus-registry.mdx index 82c2d2017e..0f4fc6349e 100644 --- a/docs/encyclopedia/nexus/nexus-registry.mdx +++ b/docs/encyclopedia/nexus/nexus-registry.mdx @@ -21,12 +21,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - The [Nexus Registry](/glossary#nexus-registry) manages [Nexus Endpoints](/nexus/endpoints). Developers can advertise available Endpoints and Services, so others can find and use them in their caller Workflows. Adding an Endpoint to the Registry deploys it for immediate runtime use. diff --git a/docs/encyclopedia/nexus/nexus-security.mdx b/docs/encyclopedia/nexus/nexus-security.mdx index b84589de7e..7de80c8a3e 100644 --- a/docs/encyclopedia/nexus/nexus-security.mdx +++ b/docs/encyclopedia/nexus/nexus-security.mdx @@ -19,12 +19,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - Temporal Cloud provides built-in Endpoint access controls and secure connectivity across Namespaces. Self-hosted deployments can implement [custom Authorizers](/self-hosted-guide/security#authorizer-plugin). diff --git a/docs/encyclopedia/nexus/nexus-services.mdx b/docs/encyclopedia/nexus/nexus-services.mdx index 2d07d9ac08..ddb75d39ba 100644 --- a/docs/encyclopedia/nexus/nexus-services.mdx +++ b/docs/encyclopedia/nexus/nexus-services.mdx @@ -19,12 +19,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - [Nexus Services](/glossary#nexus-service) are named collections of [Nexus Operations](/nexus/operations) that provide a contract for sharing across team boundaries. A [Nexus Endpoint](/nexus/endpoints) exposes Services for callers to use. diff --git a/docs/encyclopedia/nexus/nexus.mdx b/docs/encyclopedia/nexus/nexus.mdx index 0612b2fbc2..f60a195248 100644 --- a/docs/encyclopedia/nexus/nexus.mdx +++ b/docs/encyclopedia/nexus/nexus.mdx @@ -16,12 +16,6 @@ tags: import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - :::info NEW TO NEXUS? This page explains what Nexus is and how it works. To evaluate whether Nexus fits your use case, see the [evaluation guide](/evaluate/nexus). diff --git a/docs/encyclopedia/workers/serverless-workers.mdx b/docs/encyclopedia/workers/serverless-workers.mdx index 525d1220cd..78b9e05e3f 100644 --- a/docs/encyclopedia/workers/serverless-workers.mdx +++ b/docs/encyclopedia/workers/serverless-workers.mdx @@ -18,15 +18,13 @@ tags: --- import CaptionedImage from '@site/src/components/images/CaptionedImage'; +import { ReleaseNoteHeader } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. APIs are experimental and may be subject to backwards-incompatible changes. [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + This page covers the following: diff --git a/docs/encyclopedia/workflow/workflow-execution/event.mdx b/docs/encyclopedia/workflow/workflow-execution/event.mdx index 8c28c8ab6c..5713474faa 100644 --- a/docs/encyclopedia/workflow/workflow-execution/event.mdx +++ b/docs/encyclopedia/workflow/workflow-execution/event.mdx @@ -13,7 +13,7 @@ tags: - Workflows --- -import { CaptionedImage } from '@site/src/components'; +import { CaptionedImage, ReleaseNoteHeader } from '@site/src/components'; This page discusses the following: @@ -127,13 +127,9 @@ If there is any chance that the code provided to the Side Effect could fail, use ## What is Principal Attribution? {/* #principal-attribution */} -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Principal Attribution is currently available in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). - -Email addresses can be displayed, which may be considered Personally Identifiable information (PII data), and should be handled according to your organization’s privacy, access control, logging, and retention policies. - -::: + + Email addresses can be displayed, which may be considered Personally Identifiable information (PII data), and should be handled according to your organization’s privacy, access control, logging, and retention policies. + Principal Attribution for Workflow Executions is a server-derived set of non-spoofable `Principal` fields for Event history events. diff --git a/docs/evaluate/development-production-features/serverless-workers/demo.mdx b/docs/evaluate/development-production-features/serverless-workers/demo.mdx index 832bf43701..d5271dab93 100644 --- a/docs/evaluate/development-production-features/serverless-workers/demo.mdx +++ b/docs/evaluate/development-production-features/serverless-workers/demo.mdx @@ -23,15 +23,14 @@ llm_exclude: Workers documentation](/serverless-workers) for detailed information on related concepts. --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and -available to select Temporal Cloud customers. To request access during Pre-release, create a -[support ticket](/cloud/support#support-ticket) or contact your account team. APIs are experimental and may be subject -to backwards-incompatible changes. [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be -notified when Serverless Workers reach Public Preview. - -::: +import { ReleaseNoteHeader } from '@site/src/components'; + + + To request access during Pre-release, create a + [support ticket](/cloud/support#support-ticket) or contact your account team. APIs are experimental and may be subject + to backwards-incompatible changes. [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be + notified when Serverless Workers reach Public Preview. + Serverless Workers let you run Temporal Workers on serverless compute like AWS Lambda. There are no long-lived processes to provision or scale. Temporal Cloud invokes your Worker when Tasks arrive, and the Worker shuts down when the work is diff --git a/docs/evaluate/development-production-features/temporal-nexus.mdx b/docs/evaluate/development-production-features/temporal-nexus.mdx index a46ad68378..64c6a7f652 100644 --- a/docs/evaluate/development-production-features/temporal-nexus.mdx +++ b/docs/evaluate/development-production-features/temporal-nexus.mdx @@ -34,12 +34,6 @@ keywords: import { RelatedReadContainer, RelatedReadItem } from '@site/src/components'; import { CaptionedImage } from '@site/src/components'; -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability) for [Temporal Cloud](/cloud/nexus) and [self-hosted deployments](/production-deployment/self-hosted-guide/nexus). - -::: - As Temporal adoption grows across teams, organizations partition their applications into isolated Namespaces for security and fault isolation. Nexus bridges these boundaries, connecting Temporal applications across Namespaces, regions, and clouds with built-in durable execution, observability, and access control. Each team retains ownership of their own Namespace while sharing capabilities through clean service contracts. diff --git a/docs/production-deployment/self-hosted-guide/temporal-nexus.mdx b/docs/production-deployment/self-hosted-guide/temporal-nexus.mdx index b59ece929a..95e78a2e14 100644 --- a/docs/production-deployment/self-hosted-guide/temporal-nexus.mdx +++ b/docs/production-deployment/self-hosted-guide/temporal-nexus.mdx @@ -11,12 +11,6 @@ tags: - enable-nexus --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Temporal Nexus is now [Generally Available](/evaluate/development-production-features/release-stages#general-availability). - -::: - :::info NEW TO NEXUS? This page explains how to self-host Nexus. To learn about Nexus, see the [how Nexus works page](/nexus). To evaluate whether Nexus fits your use case, see the [evaluation guide](/evaluate/nexus). diff --git a/docs/production-deployment/worker-deployments/serverless-workers/aws-lambda.mdx b/docs/production-deployment/worker-deployments/serverless-workers/aws-lambda.mdx index 000efbe447..92fd8a2a2a 100644 --- a/docs/production-deployment/worker-deployments/serverless-workers/aws-lambda.mdx +++ b/docs/production-deployment/worker-deployments/serverless-workers/aws-lambda.mdx @@ -19,19 +19,17 @@ tags: --- import SdkTabs from '@site/src/components/elements/SdkTabs'; +import { ReleaseNoteHeader } from '@site/src/components'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This guide walks through deploying a Temporal [Serverless Worker](/serverless-workers) on AWS Lambda. - -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + -::: +This guide walks through deploying a Temporal [Serverless Worker](/serverless-workers) on AWS Lambda. ## Prerequisites {/* #prerequisites */} diff --git a/docs/production-deployment/worker-deployments/serverless-workers/index.mdx b/docs/production-deployment/worker-deployments/serverless-workers/index.mdx index 7b35fe1192..9b34312de5 100644 --- a/docs/production-deployment/worker-deployments/serverless-workers/index.mdx +++ b/docs/production-deployment/worker-deployments/serverless-workers/index.mdx @@ -18,14 +18,13 @@ tags: - Serverless --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + Serverless Workers let you run Temporal Workers on serverless compute like AWS Lambda. Deploy your Worker code to a serverless provider, configure a compute provider for the Worker Deployment Version, and Temporal invokes the Worker diff --git a/docs/production-deployment/worker-deployments/serverless-workers/self-hosted-setup.mdx b/docs/production-deployment/worker-deployments/serverless-workers/self-hosted-setup.mdx index 0f5a4e7464..38d5a6733c 100644 --- a/docs/production-deployment/worker-deployments/serverless-workers/self-hosted-setup.mdx +++ b/docs/production-deployment/worker-deployments/serverless-workers/self-hosted-setup.mdx @@ -19,12 +19,11 @@ tags: - Self-hosted --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO +import { ReleaseNoteHeader } from '@site/src/components'; -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). -APIs are experimental and may be subject to backwards-incompatible changes. - -::: + + APIs are experimental and may be subject to backwards-incompatible changes. + Serverless Workers require Temporal Service v1.31.0 or later. diff --git a/docs/troubleshooting/blob-size-limit-error.mdx b/docs/troubleshooting/blob-size-limit-error.mdx index 0bb8120b7d..3dd1097621 100644 --- a/docs/troubleshooting/blob-size-limit-error.mdx +++ b/docs/troubleshooting/blob-size-limit-error.mdx @@ -14,6 +14,8 @@ tags: - Failures --- +import { ReleaseNoteHeader } from '@site/src/components'; + Temporal enforces size limits on the data that passes between the Temporal Client, Workers, and the Temporal Service. There are two distinct limits, each producing different error messages and behaviors, and they require different solutions: @@ -57,26 +59,23 @@ Workflow is not terminated and remains open, so you can deploy a fix and allow t ### How to resolve 1. Offload large payloads to an object store to reduce the risk of exceeding payload size limits: - 1. Pass references to the stored payloads within the Workflow instead of the actual data. - 1. Retrieve the payloads from the object store when needed during execution. - - This is called the - [claim check pattern](https://dataengineering.wiki/Concepts/Software+Engineering/Claim+Check+Pattern). The claim - check pattern is built into the SDKs as [External Storage](/external-storage), or you can implement your own claim - check pattern by using a custom [Payload Codec](/payload-codec) + 1. Pass references to the stored payloads within the Workflow instead of the actual data. + 1. Retrieve the payloads from the object store when needed during execution. - This is the most reliable way to avoid hitting payload size limits. Consider implementing the claim check pattern for - Workflows and Activities that have the potential to receive or return large payloads, even if they are currently - within the limit. + This is called the + [claim check pattern](https://dataengineering.wiki/Concepts/Software+Engineering/Claim+Check+Pattern). The claim + check pattern is built into the SDKs as [External Storage](/external-storage), or you can implement your own claim + check pattern by using a custom [Payload Codec](/payload-codec) - :::tip Support, stability, and dependency info + This is the most reliable way to avoid hitting payload size limits. Consider implementing the claim check pattern for + Workflows and Activities that have the potential to receive or return large payloads, even if they are currently + within the limit. - External Storage is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). - APIs and configuration may change before General Availability. Join the + + APIs and configuration may change before General Availability. Join the [#large-payloads Slack channel](https://temporalio.slack.com/archives/C09VA2DE15Y) to provide feedback or ask for help. - - ::: + 1. Use compression with a [custom Payload Codec](/payload-codec) for large payloads. This may address the immediate issue, but if payload sizes continue to grow, the problem can arise again. diff --git a/docs/troubleshooting/serverless-workers.mdx b/docs/troubleshooting/serverless-workers.mdx index a64b2134d4..7dfb80301b 100644 --- a/docs/troubleshooting/serverless-workers.mdx +++ b/docs/troubleshooting/serverless-workers.mdx @@ -19,17 +19,15 @@ tags: - AWS Lambda --- -:::tip SUPPORT, STABILITY, and DEPENDENCY INFO - -Serverless Workers are in [Pre-release](/evaluate/development-production-features/release-stages#pre-release) and available to select Temporal Cloud customers. -To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. -APIs are experimental and may be subject to backwards-incompatible changes. -[Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. - -::: - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { ReleaseNoteHeader } from '@site/src/components'; + + + To request access during Pre-release, create a [support ticket](/cloud/support#support-ticket) or contact your account team. + APIs are experimental and may be subject to backwards-incompatible changes. + [Sign up for updates](https://temporal.io/pages/serverless-workers-updates) to be notified when Serverless Workers reach Public Preview. + This page walks through the Serverless Worker invocation flow and helps you identify where a failure is occurring. diff --git a/src/components/index.js b/src/components/index.js index 9c82476efc..07152382b8 100644 --- a/src/components/index.js +++ b/src/components/index.js @@ -19,8 +19,9 @@ export { default as ZoomingImage } from './images/ZoomingImage'; // Information components export { default as DiscoverableDisclosure } from './info/DiscoverableDisclosure'; export { default as ToolTipTerm } from './info/ToolTipTerm'; -export { RelatedReadContainer, RelatedReadItem } from './info/RelatedRead'; -export { default as RelatedReadList } from './info/RelatedReadList'; +export { RelatedReadContainer, RelatedReadItem } from './info/RelatedRead/RelatedRead'; +export { default as RelatedReadList } from './info/RelatedRead/RelatedReadList'; +export { default as ReleaseNoteHeader } from './info/ReleaseNoteHeader/ReleaseNoteHeader'; // Extra export export { default } from './elements/SdkTabs'; diff --git a/src/components/info/RelatedRead.js b/src/components/info/RelatedRead/RelatedRead.js similarity index 83% rename from src/components/info/RelatedRead.js rename to src/components/info/RelatedRead/RelatedRead.js index 8d8791f37d..9737432cb7 100644 --- a/src/components/info/RelatedRead.js +++ b/src/components/info/RelatedRead/RelatedRead.js @@ -2,6 +2,8 @@ import React from "react"; import clsx from "clsx"; import Link from "@docusaurus/Link"; import { v4 as uuidv4 } from "uuid"; + +import { LANGUAGE_ICONS } from "../constants"; import styles from "./RelatedRead.module.css"; const archetypeClasses = { @@ -10,18 +12,6 @@ const archetypeClasses = { "feature-summary": "archetype-tag-feature-summary", }; -const languageIcons = { - Go: "/img/sdks/svgs/golang.svg", - Java: "/img/sdks/svgs/java.svg", - PHP: "/img/sdks/svgs/php.svg", - Python: "/img/sdks/svgs/python.svg", - TypeScript: "/img/sdks/svgs/typescript.svg", - ".NET": "/img/sdks/svgs/dotnet.svg", - Ruby: "/img/sdks/svgs/ruby.svg", - Rust: "/img/sdks/svgs/rust.svg", - "Temporal CLI": "/img/assets/terminal.svg", -}; - const encyclopediaIcon = "/img/assets/link-preview-icon.svg"; function getTagClass(tag) { @@ -29,9 +19,9 @@ function getTagClass(tag) { } function getLanguageIcon(text) { - for (const lang in languageIcons) { + for (const lang in LANGUAGE_ICONS) { if (text.includes(lang)) { - return languageIcons[lang]; + return LANGUAGE_ICONS[lang]; } } return null; diff --git a/src/components/info/RelatedRead.module.css b/src/components/info/RelatedRead/RelatedRead.module.css similarity index 100% rename from src/components/info/RelatedRead.module.css rename to src/components/info/RelatedRead/RelatedRead.module.css diff --git a/src/components/info/RelatedReadList.js b/src/components/info/RelatedRead/RelatedReadList.js similarity index 100% rename from src/components/info/RelatedReadList.js rename to src/components/info/RelatedRead/RelatedReadList.js diff --git a/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.js b/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.js new file mode 100644 index 0000000000..ff428cd267 --- /dev/null +++ b/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.js @@ -0,0 +1,118 @@ +// src/components/info/ReleaseNoteHeader/index.js + +import React from "react"; +import clsx from "clsx"; +import { LANGUAGE_ICONS } from "../constants"; +import SdkSvg from '../../elements/SdkSvgs/SdkSvg'; +import styles from "./ReleaseNoteHeader.module.css"; +import { FEATURE_RELEASE_TYPES } from "../../../constants/featureReleaseTypes"; + +export const BASE_RELEASE_STAGES = { + prerelease: { + label: "Pre-release", + descriptionLink: "/evaluate/development-production-features/release-stages#pre-release", + backgroundColor: "var(--release-prerelease-bg)", + borderColor: "var(--release-prerelease-border)", + textColor: "var(--release-prerelease-text)", + }, + publicPreview: { + label: "Public Preview", + descriptionLink: "/evaluate/development-production-features/release-stages#public-preview", + backgroundColor: "var(--release-public-preview-bg)", + borderColor: "var(--release-public-preview-border)", + textColor: "var(--release-public-preview-text)", + }, +}; + +const LANGUAGE_TO_SDK_SVG = { + ".NET": "dotnetBlock", + "Go": "goLangBlock", + "Java": "javaBlock", + "PHP": "phpBlock", + "Python": "pythonBlock", + "Ruby": "rubyBlock", + "Rust": "rustBlock", + "TypeScript": "typeScriptBlock", +} + +function getResolvedType({ featureName, type }) { + return FEATURE_RELEASE_TYPES[featureName] || type || "publicPreview"; +} + +function getTheme(type, overrides = {}) { + return { + ...(BASE_RELEASE_STAGES[type] || BASE_RELEASE_STAGES.publicPreview), + ...Object.fromEntries( + Object.entries(overrides).filter(([, value]) => value !== undefined) + ), + }; +} + +export default function ReleaseNoteHeader({ + // type can be "prerelease" or "publicPreview" + type = "publicPreview", + // name of the feature being released + featureName, + // If there is anything specific to say about the release, it can be passed as a child to the component. It can also be a link if href is provided. + children = "APIs and configuration may change before the stable release.", + // If child is a link, this is where the link can be passed. + href, + // These are the supported languages for the release. If provided, icons for these languages will be shown. + languages = [], + // If you want to override the default label for the release type, you can pass it here. This is useful for cases like "generalAvailability" where you might want to just say "Stable". + label, +}) { + const resolvedType = getResolvedType({ featureName, type }); + const theme = getTheme(resolvedType); + + const releaseLabel = label || theme.label; + + const style = { + "--release-note-background": theme.backgroundColor, + "--release-note-border": theme.borderColor, + "--release-note-text": theme.textColor, + }; + + return ( + + ); +} \ No newline at end of file diff --git a/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.module.css b/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.module.css new file mode 100644 index 0000000000..0ace8e0466 --- /dev/null +++ b/src/components/info/ReleaseNoteHeader/ReleaseNoteHeader.module.css @@ -0,0 +1,102 @@ +:root { + /* Pre-release */ + --release-prerelease-bg: #fef3c7; + --release-prerelease-border: #f59e0b; + --release-prerelease-text: #111827; + + /* Public Preview */ + --release-public-preview-bg: #eff6ff; + --release-public-preview-border: #8b5cf6; + --release-public-preview-text: #111827; +} + +[data-theme="dark"] { + /* Pre-release */ + --release-prerelease-bg: #422006; + --release-prerelease-border: #fbbf24; + --release-prerelease-text: #e6f6e6; + + /* Public Preview */ + --release-public-preview-bg: #2e1065; + --release-public-preview-border: #a78bfa; + --release-public-preview-text: #e6f6e6; +} + +.releaseNoteHeader { + display: flex; + gap: 0.875rem; + margin: 0 0 1.5rem; + padding: 1rem; + border: 1px solid var(--release-note-border); + background: var(--release-note-background); + color: var(--release-note-text); +} + +.accent { + width: 0.25rem; + border-radius: 999px; + background: var(--release-note-border); +} + +.meta { + display: flex; + flex-wrap: wrap; + gap: 0.5rem; + align-items: center; +} + +.pill { + font-weight: 700; + font-size: 0.8rem; + text-transform: uppercase; +} + +.text { + margin: 0.35rem 0 0; +} + +.text > p { + margin: unset; +} + +.headerRow { + display: flex; + justify-content: space-between; + gap: 1rem; + align-items: flex-start; +} + +.languages { + display: flex; + flex-wrap: wrap; + gap: 0.375rem; + margin: 0; + padding: 0; + list-style: none; + align-items: center; +} + +.languageIcon svg { + width: 100%; + height: 100%; + display: block; +} + +.language { + display: flex; + align-items: center; + gap: 0.25rem; + margin-top: 10px; +} + +.supportedLanguages { + display: flex; + align-items: center; + gap: 0.5rem; +} + +@media (max-width: 640px) { + .headerRow { + flex-direction: column; + } +} \ No newline at end of file diff --git a/src/components/info/constants.js b/src/components/info/constants.js new file mode 100644 index 0000000000..1b32faa8ba --- /dev/null +++ b/src/components/info/constants.js @@ -0,0 +1,11 @@ +export const LANGUAGE_ICONS = { + Go: "/img/sdks/svgs/golang.svg", + Java: "/img/sdks/svgs/java.svg", + PHP: "/img/sdks/svgs/php.svg", + Python: "/img/sdks/svgs/python.svg", + TypeScript: "/img/sdks/svgs/typescript.svg", + ".NET": "/img/sdks/svgs/dotnet.svg", + Ruby: "/img/sdks/svgs/ruby.svg", + Rust: "/img/sdks/svgs/rust.svg", + "Temporal CLI": "/img/assets/terminal.svg", +}; \ No newline at end of file diff --git a/src/constants/featureReleaseTypes.js b/src/constants/featureReleaseTypes.js new file mode 100644 index 0000000000..399303b38c --- /dev/null +++ b/src/constants/featureReleaseTypes.js @@ -0,0 +1,7 @@ +export const FEATURE_RELEASE_TYPES = { + cloudCli: "prerelease", + standaloneActivity: "prerelease", + nexus: "publicPreview", + workflowStreams: "publicPreview", + serverlessWorkers: "prerelease", +}; \ No newline at end of file