Skip to content

Commit

Permalink
Merge branch 'main' into evaluatetemporal-howitworks
Browse files Browse the repository at this point in the history
  • Loading branch information
jsundai authored Jun 5, 2024
2 parents 8f0d402 + 6043b83 commit 37b1ebd
Show file tree
Hide file tree
Showing 463 changed files with 18,186 additions and 33,572 deletions.
8 changes: 4 additions & 4 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

// List of extensions which should be recommended for users of this workspace.
"recommendations": ["esbenp.prettier-vscode"],
"recommendations": [
"dprint.dprint",
"chrischinchilla.vale-vscode"
],
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
"unwantedRecommendations": []
}
13 changes: 1 addition & 12 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
{
"prettier.singleQuote": true,
"prettier.jsxSingleQuote": true,
"editor.formatOnSave": true,
"cSpell.words": ["upsert"],
"cSpell.customDictionaries": {
"custom-dictionary-workspace": {
"name": "custom-dictionary-workspace",
"path": "${workspaceFolder:documentation}/.cspell/custom-dictionary-workspace.txt",
"addWords": true,
"scope": "workspace"
}
},
"docwriter.style": "Auto-detect"
"editor.defaultFormatter": "dprint.dprint"
}
2 changes: 1 addition & 1 deletion docs/cli/activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: activity
title: Temporal CLI activity command reference
sidebar_label: activity
description: Explore the Temporal CLI Activity commands for efficient management of Activities. Register, inspect, and interact with Activities in your Workflows.
description: Learn how to use Temporal Activity commands for completing or failing Activity Executions in your Workflow. Optimize your Temporal Workflow management effectively.
toc_max_heading_level: 4
keywords:
- activity
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/batch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: batch
title: Temporal CLI batch command reference
sidebar_label: batch
description: Efficiently execute batch operations with the Temporal CLI. Automate and manage bulk operations seamlessly.
description: Use Temporal CLI to manage multiple Workflow Executions with Batch Jobs that can Cancel, Signal, or Terminate Workflows. Filter and monitor Batch Jobs effectively.
toc_max_heading_level: 4
keywords:
- batch
Expand Down Expand Up @@ -32,7 +32,7 @@ The List Filter identifies the Workflow Executions in the Batch Job; the Batch t
There are three types of Batch Jobs:

- Cancel: cancels the Workflow Executions specified by the List Filter.
- Signal: sends a [Signal](/workflows#signal) to the Workflow Executions specified by the List Filter.
- Signal: sends a [Signal](/encyclopedia/application-message-passing#signals) to the Workflow Executions specified by the List Filter.
- Terminate: terminates the Workflow Executions specified by the List Filter.

Batch operations can affect multiple Workflows simultaneously.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/cmd-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: cmd-options
title: Temporal CLI command options reference
sidebar_label: cmd options
description: Explore the command-line options available in the Temporal CLI. Customize and configure various aspects of the Temporal CLI tool for seamless Workflow management.
description: Discover how to manage Temporal Workflows, from Activity Execution to Workflow Ids, using clusters, cron schedules, dynamic configurations, and logging. Perfect for developers.
toc_max_heading_level: 4
keywords:
- actions
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: env
title: Temporal CLI env command reference
sidebar_label: env
description: Discover the Temporal CLI environment configuration documentation. Set up and customize various aspects of your environment.
description: Temporal CLI 'env' commands allow the configuration, setting, deleting, and listing of environmental properties, making it easy to manage Temporal Server instances.
toc_max_heading_level: 4
keywords:
- cli reference
Expand Down
3 changes: 1 addition & 2 deletions docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
id: index
title: Temporal CLI command reference
sidebar_label: Temporal CLI
sidebar_position: 8
description: Discover the Temporal Command Line Interface (CLI) documentation. Navigate, configure, and utilize the Temporal CLI effectively.
description: The Temporal CLI offers terminal access to Temporal Services for managing, monitoring, and debugging Workflows and Activities, including Namespace and Task Queue management, with embedded development support.
slug: /cli
toc_max_heading_level: 4
keywords:
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/operator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: operator
title: Temporal CLI operator command reference
sidebar_label: operator
description: Efficiently use the Temporal CLI to manage operator actions on Namespaces, Search Attributes, and Temporal Clusters. Create, update, list, and remove resources.
description: Operator commands in Temporal allow actions on Namespaces, Search Attributes, and Clusters using specific subcommands. Execute with "temporal operator [command] [subcommand] [options]".
toc_max_heading_level: 4
keywords:
- cli reference
Expand Down Expand Up @@ -613,7 +613,7 @@ Use the following options to change this command's behavior.

### list

The `temporal operator search-attribute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in [Queries](/workflows#query).
The `temporal operator search-attribute list` command displays a list of all [Search Attributes](/visibility#search-attribute) that can be used in [Queries](/encyclopedia/application-message-passing#queries).

`temporal workflow list --query`.

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/schedule.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: schedule
title: Temporal CLI schedule command reference
sidebar_label: schedule
description: Create, update, trigger, and delete Schedules in Temporal Workflows by using these commands and options in the Temporal CLI.
description: Temporal's Schedule commands allow users to create, update, and manage Workflow Executions seamlessly for automation, supporting commands for creation, backfill, deletion, and more.
toc_max_heading_level: 4
keywords:
- backfill
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: server
title: Temporal CLI server command reference
sidebar_label: server
description: Effectively manage the Temporal Server by using the Temporal command-line interface (CLI). Explore documentation about administration and configuration.
description: Manage your Temporal Server easily with CLI commands. Start a local server using `temporal server start-dev` and access the Web UI at http://localhost:8233. Customize with multiple options.
toc_max_heading_level: 4
keywords:
- cli reference
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/task-queue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: task-queue
title: Temporal CLI task-queue command reference
sidebar_label: task-queue
description: Efficiently manage Task Queues with the Temporal CLI. Create, configure, and monitor Task Queues to optimize Workflow Execution and Task processing.
description: Temporal Task Queue commands facilitate operations like describing poller info, displaying partitions, fetching compatible Build IDs, and determining Build ID reachability for effective Workflow and Activity management.
toc_max_heading_level: 4
keywords:
- cli reference
Expand All @@ -25,7 +25,7 @@ To run a Task Queue command, run `temporal task-queue [command] [command options

## describe

The `temporal task-queue describe` command provides [poller](/dev-guide/worker-performance#poller-count) information for a given [Task Queue](/workers#task-queue).
The `temporal task-queue describe` command provides [poller](/develop/worker-performance#poller-count) information for a given [Task Queue](/workers#task-queue).

The [Server](/clusters#temporal-server) records the last time of each poll request.
A `LastAccessTime` value in excess of one minute can indicate the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down.
Expand Down
8 changes: 4 additions & 4 deletions docs/cli/workflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: workflow
title: Temporal CLI workflow command reference
sidebar_label: workflow
description: Effectively manage Workflows with the Temporal CLI. Explore comprehensive documentation on commands and options for Workflow management and monitoring.
description: Temporal Workflow commands enable operations on Workflow Executions, such as cancel, count, delete, describe, execute, list, query, reset, reset-batch, show, signal, stack, start, terminate, trace, and update, enhancing efficiency and control.
toc_max_heading_level: 4
keywords:
- call stack
Expand Down Expand Up @@ -398,7 +398,7 @@ Use the following command options to change the information returned by this com

## query

The `temporal workflow query` command sends a [Query](/workflows#query) to a [Workflow Execution](/workflows#workflow-execution).
The `temporal workflow query` command sends a [Query](/encyclopedia/application-message-passing#queries) to a [Workflow Execution](/workflows#workflow-execution).

Queries can retrieve all or part of the Workflow state within given parameters.
Queries can also be used on completed [Workflows](/workflows#workflow-execution).
Expand Down Expand Up @@ -623,7 +623,7 @@ Use the following options to change the behavior of this command.

## signal

The `temporal workflow signal` command is used to send a [Signal](/workflows#signal) to a [Workflow Execution](/workflows#workflow-execution) by [Workflow Id](/workflows#workflow-id) or [List Filter](/visibility#list-filter).
The `temporal workflow signal` command is used to send a [Signal](/encyclopedia/application-message-passing#signals) to a [Workflow Execution](/workflows#workflow-execution) by [Workflow Id](/workflows#workflow-id) or [List Filter](/visibility#list-filter).

Use the following options to change the command's behavior.

Expand Down Expand Up @@ -673,7 +673,7 @@ Use the following options to change the command's behavior.

## stack

The `temporal workflow stack` command queries a [Workflow Execution](/workflows#workflow-execution) with `--stack-trace` as the [Query](/workflows#stack-trace-query) type.
The `temporal workflow stack` command queries a [Workflow Execution](/workflows#workflow-execution) with `--stack-trace` as the [Query](/encyclopedia/application-message-passing#stack-trace-query) type.
Returning the call stack of all the threads owned by a Workflow Execution can be great for troubleshooting in production.

Use the following options to change the command's behavior.
Expand Down
44 changes: 22 additions & 22 deletions docs/components/Intro.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,28 @@ const coreConcepts = [

const appDevGuideLinks = [
{
path: "/dev-guide/go",
name: "Go SDK developer's guide",
path: "/develop/go",
name: "Go SDK feature guides",
},
{
path: "/dev-guide/java",
name: "Java SDK developer's guide",
path: "/develop/java",
name: "Java SDK feature guides",
},
{
path: "/dev-guide/python",
name: "Python SDK developer's guide",
path: "/develop/python",
name: "Python SDK feature guides",
},
{
path: "/dev-guide/typescript",
name: "TypeScript SDK developer's guide",
path: "/develop/typescript",
name: "TypeScript SDK feature guides",
},
{
path: "https://github.com/temporalio/sdk-dotnet#readme",
name: ".NET SDK readme",
path: "/develop/python",
name: ".NET SDK feature guides",
},
{
path: "/dev-guide/php",
name: "PHP SDK developer's guide",
path: "/develop/php",
name: "PHP SDK feature guides",
},
];

Expand Down Expand Up @@ -93,7 +93,7 @@ const references = [
},
{
path: "/references/cluster-metrics",
name: "Cluster metrics",
name: "Temporal Service metrics",
},
{
path: "/references/errors",
Expand Down Expand Up @@ -218,17 +218,17 @@ function CommunityCard({ title, content, link }) {

const slides = [
{
title: "Temporal Cluster",
title: "Temporal Service",
description: "Provides reliable and scalable workflow orchestration.",
content1: `A Temporal Cluster ensures that Workflows are resilient by saving each step the Workflow code takes. It also schedules retries whenever there are errors in your application’s code.`,
content2: `You can run it wherever you’d like and scale from a single laptop to thousands of machines, adding resources when and where you need them. And although you've just set up a lightweight Cluster for development, switching your code to point at a production Cluster only requires changing your connection parameters.`,
content1: `A Temporal Service ensures that Workflows are resilient by saving each step the Workflow code takes. It also schedules retries whenever there are errors in your application’s code.`,
content2: `You can run it wherever you’d like and scale from a single laptop to thousands of machines, adding resources when and where you need them. And although you've just set up a lightweight Temporal Service for development, switching your code to point at a production Temporal Service only requires changing your connection parameters.`,
giphy: "eePSFNBFv2W9owZ4Sh",
},
{
title: "SDKs",
description: "Write code in your programming language of choice.",
content1:
"A Temporal SDK is a library you use in your code. Each SDK has two parts to its API: the Client and the Worker. The Worker is the long-running process that has your Workflow code. The Client is used to communicate with the Cluster—for instance, to start and interact with Workflows.",
"A Temporal SDK is a library you use in your code. Each SDK has two parts to its API: the Client and the Worker. The Worker is the long-running process that has your Workflow code. The Client is used to communicate with the Temporal Service—for instance, to start and interact with Workflows.",
giphy: "6UFgdU9hirj1pAOJyN",
},
{
Expand Down Expand Up @@ -256,15 +256,15 @@ const slides = [
title: "Workers",
description:
"Workers run Workflow and Activity code reliably and consistently. You can increase the scalability and availability of your application by running additional Workers. ",
content1: `One thing that people new to Temporal find surprising is that the Temporal Cluster does not execute your code.`,
content2: `You deploy your code to containers or machines that are separate from the Temporal Cluster. Using the Worker API provided by the Temporal SDK, you will run one or more Worker processes that will execute your Workflow and Activity code based on tasks managed by the Temporal Cluster.`,
content3: `The Cluster gives the Workers tasks like “Start running Workflow A,” and the Workers run the corresponding Workflow function or method.`,
content1: `One thing that people new to Temporal find surprising is that the Temporal Service does not execute your code.`,
content2: `You deploy your code to containers or machines that are separate from the Temporal Service. Using the Worker API provided by the Temporal SDK, you will run one or more Worker processes that will execute your Workflow and Activity code based on tasks managed by the Temporal Service.`,
content3: `The Temporal Service gives the Workers tasks like “Start running Workflow A,” and the Workers run the corresponding Workflow function or method.`,
giphy: "DhstvI3zZ598Nb1rFf",
},
{
title: "Temporal CLI",
description: "Communicate directly with the Temporal Cluster by entering commands in the terminal.",
content1: `The Temporal CLI runs a development version of the Cluster. Interact with the Cluster - start Workflows, list them, get their status, and more.`,
description: "Communicate directly with the Temporal Service by entering commands in the terminal.",
content1: `The Temporal CLI runs a development version of the Temporal Service. Interact with the Temporal Service - start Workflows, list them, get their status, and more.`,
content2: ` From the command line using the temporal command. From code, using an SDK Client. From your browser, using the Web UI.`,
giphy: "GA2dwDU7owOS4",
},
Expand Down
10 changes: 5 additions & 5 deletions docs/components/SdkLogos.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@ import React from "react";

const supportedTech = [
{
link: "/dev-guide/go",
link: "/develop/go",
image: "/img/golang.svg",
alt: "Go lang logo",
class: "w-10 h-8",
},
{
link: "/dev-guide/java",
link: "/develop/java",
image: "/img/java.svg",
alt: "Java logo",
class: "w-7 h-7",
},
{
link: "/dev-guide/python",
link: "/develop/python",
image: "/img/python.svg",
alt: "Python logo",
class: "w-7 h-7",
},
{
link: "/dev-guide/typescript",
link: "/develop/typescript",
image: "/img/typescript.svg",
alt: "TypeScript logo",
class: "w-7 h-7",
},
{
link: "/dev-guide/php",
link: "/develop/php",
image: "/img/php.svg",
alt: "php logo",
class: "w-10",
Expand Down
Loading

0 comments on commit 37b1ebd

Please sign in to comment.