Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removes sidebar position since this is done in our config files #2816

Merged
merged 8 commits into from
May 14, 2024
Merged

Removes sidebar position since this is done in our config files #2816

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2335384
Removes sidebar position since this is done in our config files
rachfop May 8, 2024
4716706
Merge main into branch
rachfop May 8, 2024
b0af10f
Fix merges
rachfop May 8, 2024
ad2a996
fix
rachfop May 8, 2024
1c42415
Fix bad comments
rachfop May 8, 2024
966f0a3
Fixes per comments
rachfop May 8, 2024
8c62730
Merge branch 'main' into fix-side-bar
rachfop May 9, 2024
8453aad
Merge branch 'main' into fix-side-bar
rachfop May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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.
slug: /cli
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/cancellation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: cancellation
title: Cancellation - Go SDK feature guide
sidebar_label: Cancellation
sidebar_position: 6
description: How to cancel a Workflow Execution and it's Activities using the Go SDK.
slug: /dev-guide/go/cancellation
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/converters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: converters
title: Converters and Codecs - Go SDK feature guide
sidebar_label: Converters and Codecs
sidebar_position: 11
description: The Converters and Codecs section of the Temporal Developer's guide provides guidance on how to support compression, encryption, and other special data handling by implementing custom converters and codecs.
slug: /dev-guide/go/converters
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/debugging.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: debugging
title: Debugging - Go SDK feature guide
sidebar_label: Debugging
sidebar_position: 9
description: The Debugging section of the Temporal Go SDK Developer's guide covers the many ways to debug your application.
slug: /dev-guide/go/debugging
toc_max_heading_level: 4
Expand Down
4 changes: 0 additions & 4 deletions docs/dev-guide/golang/durable-execution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: durable-execution
title: Develop code that durably executes - Go SDK dev guide
sidebar_label: Develop for durability
sidebar_position: 3
description: The Durable Execution section of the Temporal Developer's guide covers advanced beginner concepts for working with Temporal, including testing your code, reviewing workflow event history, adding timers, and understanding determinism. Developing for durable execution is a core aspect of Temporal.
slug: /dev-guide/go/durable-execution
toc_max_heading_level: 4
Expand Down Expand Up @@ -180,7 +179,6 @@ If the Workflow Definition and the Event History are incompatible then the test

```go


// TestReplayWorkflowHistoryFromFile tests for Event History compatibility.
func (s *UnitTestSuite) TestReplayWorkflowHistoryFromFile() {
// Create a new Replayer
Expand Down Expand Up @@ -255,7 +253,6 @@ import (
"documentation-samples-go/dev-guide/chapters/durability/activities"
)


// BackgroundCheckNonDeterministic is an anti-pattern Workflow Definition
func BackgroundCheckNonDeterministic(ctx workflow.Context, param string) (string, error) {
activityOptions := workflow.ActivityOptions{
Expand Down Expand Up @@ -458,7 +455,6 @@ import (
"documentation-samples-go/dev-guide/chapters/durability/activities"
)


// BackgroundCheck is your custom Workflow Definition.
func BackgroundCheck(ctx workflow.Context, param string) (string, error) {
// highlight-start
Expand Down
5 changes: 0 additions & 5 deletions docs/dev-guide/golang/features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: features
title: Features - Go SDK feature guide
sidebar_label: Features
sidebar_position: 5
description: The Features section of the Temporal Developer's guide provides basic implementation guidance on how to use many of the development features available to Workflows and Activities in the Temporal Platform.
slug: /dev-guide/go/features
toc_max_heading_level: 4
Expand Down Expand Up @@ -421,7 +420,6 @@ Ensure that every Workflow listening to the same Update name can handle the same

```go


// YourUpdateName holds a string value used to correlate Updates.
const YourUpdateName = "your_update_name"
// ...
Expand Down Expand Up @@ -455,7 +453,6 @@ Update handlers, unlike Query handlers, can change Workflow state.

```go


// ...
func YourUpdatableWorkflow(ctx workflow.Context, param WFParam) (WFResult, error) {
counter := param.StartCount
Expand Down Expand Up @@ -493,7 +490,6 @@ The platform treats a panic in the Validator function as a rejection of the Upda

```go


// UpdatableWorkflowWithValidator is a Workflow Definition.
// This Workflow Definition has an Update handler that uses the isPositive() validator function.
// After setting the Update hanlder it sleeps for 1 minutue.
Expand Down Expand Up @@ -545,7 +541,6 @@ If you supply only the Workflow Id (and provide an empty string as the Run Id pa

```go


func main() {
// ...
// Set the Update argument values.
Expand Down
6 changes: 0 additions & 6 deletions docs/dev-guide/golang/foundations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: foundations
title: Foundations - Go SDK feature guide
sidebar_label: Foundations
sidebar_position: 4
description: The Foundations section of the Temporal Go SDK Developer's guide covers the minimum set of concepts and implementation details needed to build and run a Temporal Application in Go – that is, all the relevant steps to start a Workflow Execution that executes an Activity.
slug: /dev-guide/go/foundations
toc_max_heading_level: 4
Expand Down Expand Up @@ -311,7 +310,6 @@ import (
"go.temporal.io/sdk/workflow"
)


// YourWorkflowParam is the object passed to the Workflow.
type YourWorkflowParam struct {
WorkflowParamX string
Expand Down Expand Up @@ -530,7 +528,6 @@ However, all parameters must be serializable (parameters can’t be channels, fu

```go


// YourActivityParam is the struct passed to your Activity.
// Use a struct so that your function signature remains compatible if fields change.
type YourActivityParam struct {
Expand Down Expand Up @@ -561,7 +558,6 @@ You may wish to use a `struct` type to hold all custom values, just keep in mind

```go


// YourActivityResultObject is the struct returned from your Activity.
// Use a struct so that you can return multiple values of different types.
// Additionally, your function signature remains compatible if the fields change.
Expand Down Expand Up @@ -993,7 +989,6 @@ import (
"documentation-samples-go/yourapp"
)


func main() {
// Create a Temporal Client
// A Temporal Client is a heavyweight object that should be created just once per process.
Expand Down Expand Up @@ -1504,7 +1499,6 @@ import (
"documentation-samples-go/cloud"
)


func main() {
// Get the key and cert from your env or local machine
clientKeyPath := "./secrets/yourkey.key"
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: index
title: Temporal Go SDK development documentation
sidebar_label: Go SDK
sidebar_position: 2
description: Learn how to use the Temporal Go SDK.
slug: /dev-guide/go
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: introduction
title: Introduction to the Temporal Go SDK
sidebar_label: Introduction
sidebar_position: 1
description: Learn more about Temporal Go SDK.
slug: /dev-guide/go/introduction
toc_max_heading_level: 4
Expand Down
2 changes: 0 additions & 2 deletions docs/dev-guide/golang/observability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: observability
title: Observability - Go SDK feature guide
sidebar_label: Observability
sidebar_position: 7
description: Improve observability in your Go-based Temporal Workflows. View which Workflow Executions are tracked by the Temporal Platform and the state of any Workflow Execution.
slug: /dev-guide/go/observability
toc_max_heading_level: 4
Expand Down Expand Up @@ -248,7 +247,6 @@ workflow.WithActivityOptions(ctx, ao)
"name": name,
}


logger.Info("Compressed Payloads workflow completed.", "result", result)

return result, nil
Expand Down
13 changes: 2 additions & 11 deletions docs/dev-guide/golang/project-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: project-setup
title: Set up a Temporal Application project - Go SDK dev guide
sidebar_label: Project setup
sidebar_position: 2
description: The project setup section of the Temporal Go SDK Developer's guide covers the minimum set of concepts and implementation details needed to build and run a Temporal Application in Go—that is, all the relevant steps to start a Workflow Execution that executes an Activity.
slug: /dev-guide/go/project-setup
toc_max_heading_level: 4
Expand Down Expand Up @@ -391,7 +390,6 @@ import (
"documentation-samples-go/dev-guide/chapters/setup/activities"
)


// BackgroundCheck is your custom Workflow Definition.
func BackgroundCheck(ctx workflow.Context, param string) (string, error) {
// Define the Activity Execution options
Expand Down Expand Up @@ -452,7 +450,6 @@ import (
"context"
)


// SSNTraceActivity is your custom Activity Definition.
func SSNTraceActivity(ctx context.Context, param string) (*string, error) {
// This is where a call to another service is made
Expand Down Expand Up @@ -501,7 +498,6 @@ import (
"documentation-samples-go/dev-guide/chapters/setup/workflows"
)


func main() {
// Initialize a Temporal Client
// Specify the Namespace in the Client options
Expand Down Expand Up @@ -571,7 +567,6 @@ import (
"documentation-samples-go/dev-guide/chapters/setup/workflows"
)


func main() {
err := godotenv.Load(".env")
if err != nil {
Expand Down Expand Up @@ -617,6 +612,8 @@ func main() {
}
```

Copy the Namespace Id and the gRPC endpoint from the Namespace detail Web page on [Temporal Cloud Namespaces](https://cloud.temporal.io/namespaces). Click on a Namespace name to open the Namespace details.

To run a Temporal Cloud Worker, you'll change some parameters in your Client connection code, such as updating the namespace and gRPC endpoint.
You'll use:

Expand All @@ -625,8 +622,6 @@ You'll use:
The endpoint uses this format `(namespace.unique_id.tmprl.cloud:port)`.
- [Paths to the SSL certificate (.pem) and private key (.key)](https://docs.temporal.io/cloud/saml#integrate-saml-with-your-temporal-cloud-account) registered to your Namespace and stored on your Worker's file system.

Copy the Namespace Id and the gRPC endpoint from the Namespace detail Web page on [Temporal Cloud Namespaces](https://cloud.temporal.io/namespaces). Click on a Namespace name to open the Namespace details.

### Run a Self-hosted Worker {#dockerfile}

To deploy a self-hosted Worker to your Docker environment, you need to configure your Worker with the appropriate IP address and port.
Expand Down Expand Up @@ -716,7 +711,6 @@ import (
"documentation-samples-go/dev-guide/chapters/setup/workflows"
)


func main() {
// Initialize a Temporal Client
// Specify the IP, port, and Namespace in the Client options
Expand Down Expand Up @@ -1033,7 +1027,6 @@ import (
"documentation-samples-go/dev-guide/chapters/setup/workflows"
)


// UnitTestSuite is a struct that wraps around the testing suites
type UnitTestSuite struct {
// Add testify test suite package
Expand Down Expand Up @@ -1072,7 +1065,6 @@ We can also perform a Workflow Replay test, and we'll provide detailed coverage

```go


const ssn string = "555-55-5555"

// Test_BackgroundCheckWorkflow tests the BackgroundCheck Workflow function
Expand Down Expand Up @@ -1125,7 +1117,6 @@ We can test Activity code for the following conditions:

```go


// Test_SSNTraceActivity tests the SSNTraceActivity function
func (s *UnitTestSuite) Test_SSNTraceActivity() {
// Create a test environment
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: testing
title: Testing - Go SDK feature guide
sidebar_label: Testing
sidebar_position: 8
description: The Testing section of the Temporal Developer's guide covers the many ways to test the state of your Temporal Application; that is, ways to view which Workflow Executions are tracked by the Platform and the state of any given Workflow Execution, either currently or at points of an execution.
slug: /dev-guide/go/testing
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/golang/versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: versioning
title: Versioning - Go SDK feature guide
sidebar_label: Versioning
sidebar_position: 10
description: The Versioning section of the Temporal Developer's guide covers how to update Workflow Definitions without causing non-deterministic behavior in current long-running Workflows.
slug: /dev-guide/go/versioning
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ id: index
title: Build durable applications with Temporal
description: The Temporal developer's guide provides a comprehensive overview of the structures, primitives, and features used in Temporal Application development.
sidebar_label: Development
sidebar_position: 4
---

import { SdkLogos } from '../components/SdkLogos';
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/converters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: converters
title: Converters and Codecs - Java SDK feature guide
sidebar_label: Converters and Codecs
sidebar_position: 10
description: The Converters and Codecs section of the Temporal Developer's guide provides guidance on how to support compression, encryption, and other special data handling by implementing custom converters and codecs.
slug: /dev-guide/java/converters
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/debugging.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: debugging
title: Debugging - Java SDK feature guide
sidebar_label: Debugging
sidebar_position: 9
description: The Debugging section of the Temporal Developer's guide covers the many ways to debug your application.
slug: /dev-guide/java/debugging
toc_max_heading_level: 4
Expand Down
4 changes: 0 additions & 4 deletions docs/dev-guide/javalang/durable-execution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: durable-execution
title: Develop code that durably executes - Java SDK dev guide
sidebar_label: Develop for durability
sidebar_position: 3
description: The Durable Execution section of the Temporal Developer's guide covers advanced beginner concepts for working with Temporal, including testing your code, reviewing workflow event history, adding timers, and understanding determinism. Developing for durable execution is a core aspect of Temporal.
slug: /dev-guide/java/durable-execution
toc_max_heading_level: 4
Expand Down Expand Up @@ -236,8 +235,6 @@ import org.slf4j.Logger;
import java.time.Duration;
import java.util.Random;



public class BackgroundCheckReplayNonDeterministicWorkflowImpl implements BackgroundCheckReplayNonDeterministicWorkflow {

// Define the Activity Execution options
Expand Down Expand Up @@ -367,7 +364,6 @@ import org.slf4j.Logger;

import java.time.Duration;


public class BackgroundCheckReplayWorkflowImpl implements BackgroundCheckReplayWorkflow {

public static final Logger logger = Workflow.getLogger(BackgroundCheckReplayWorkflowImpl.class);
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: features
title: Features - Java SDK feature guide
sidebar_label: Features
sidebar_position: 6
description: The Features section of the Temporal Developer's guide provides basic implementation guidance on how to use many of the development features available to Workflows and Activities in the Temporal Platform.
slug: /dev-guide/java/features
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/foundations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: foundations
title: Foundations - Java SDK feature guide
sidebar_label: Foundations
sidebar_position: 4
description: The Foundations section of the Temporal Developer's guide covers the minimum set of concepts and implementation details needed to build and run a Temporal Application – that is, all the relevant steps to start a Workflow Execution that executes an Activity.
slug: /dev-guide/java/foundations
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: index
title: Temporal Java SDK development documentation
sidebar_label: Java SDK
sidebar_position: 2
description: Learn how to use Temporal Java SDK.
slug: /dev-guide/java
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: introduction
title: Introduction to the Temporal Java SDK
sidebar_label: Introduction
sidebar_position: 1
description: Learn more about Temporal Java SDK.
slug: /dev-guide/java/introduction
toc_max_heading_level: 4
Expand Down
1 change: 0 additions & 1 deletion docs/dev-guide/javalang/observability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
id: observability
title: Observability - Java SDK feature guide
sidebar_label: Observability
sidebar_position: 7
description: Improve observability in your Java-based Temporal Workflows. View which Workflow Executions are tracked by the Temporal Platform and the state of any Workflow Execution.
slug: /dev-guide/java/observability
toc_max_heading_level: 4
Expand Down
Loading