Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

title fixes #346

Merged
merged 3 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion docs/courses/errstrat/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ To be successful in this course, you should have an understanding of the fundame

Since code used in examples and exercises are written in Go, you must also have at least basic proficiency with the Go programming language.

<a className="button button--primary" href="https://temporal.talentlms.com/catalog/info/id:246">Go to Course</a>
<a className="button button--primary" href="https://temporal.talentlms.com/catalog/info/id:246">Go to Course</a>
5 changes: 4 additions & 1 deletion docs/courses/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ last_update:
date: 2024-03-28
keywords: [courses, training, self-paced learning, workshop, class, Temporal]
image: /img/temporal-logo-twitter-card.png
description: "Grow your Temporal knowledge with free self-paced, hands-on online courses."
---

import Link from '@docusaurus/Link';

![Temporal Courses](/img/banners/courses.png)
<h1>
<img alt="Temporal Courses" src="/img/banners/courses.png" />
</h1>

Go deeper with self-paced online courses that provide in-depth hands-on learning experiences.

Expand Down
4 changes: 2 additions & 2 deletions docs/courses/temporal_101/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: "Temporal 101 with Python"
draft: false
tags: [courses, Python]
keywords: [Temporal, Workflows, Activities, Python SDK, external service, recovery, execution model, event history, Temporal Web UI, command-line tools, business process, application lifecycle]
description: "Discover the essentials of Temporal application development in this course, focusing on Workflows, Activities, and the Python SDK. You'll develop a small app, recover from failures, and use Temporal's execution model and tools to manage your application lifecycle effectively."
description: "Discover the essentials of Temporal application development in this course, focusing on Workflows, Activities, and the Temporal Python SDK. Start the course today."
custom_edit_url: null
hide_table_of_contents: true
last_update:
Expand Down Expand Up @@ -39,4 +39,4 @@ To be successful in this course, you should have experience writing backend appl

This course uses the Python programming language. Although the code examples and hands-on exercises are written in Python, they include explanations and avoid advanced language features, so a developer with minimal Python experience should be able to successfully complete this course.

<a className="button button--primary" href="https://temporal.talentlms.com/catalog/info/id:143">Go to Course</a>
<a className="button button--primary" href="https://temporal.talentlms.com/catalog/info/id:143">Go to Course</a>
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
id: application-design
sidebar_position: 4
keywords: [go, golang, temporal, sdk, tutorial]
title: How to design and implement the Background Check application
description: Start by mapping business process to Workflows.
title: Background Check Application Design
description: Design the Background Check application by mapping business process to Workflows.
tags: [Go, SDK]
image: /img/temporal-logo-twitter-card.png
---
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/go/background-checks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: project-narrative
sidebar_position: 1
keywords: [go, golang, temporal, sdk, tutorial]
title: Background Check Application in Go
description: The goal of this project is to teach you, the developer, how to think about building Temporal Applications that have Human-Driven Long-Running Workflows using a Temporal SDK, by leading you through a comprehensive implementation within the context of a real-life use case.
description: Understand how to design and implement a background check application using the Temporal Go SDK.
image: /img/temporal-logo-twitter-card.png
---

Expand Down
40 changes: 25 additions & 15 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,52 @@ sidebar_position: 5
hide_table_of_contents: true
pagination_next: null
image: /img/temporal-logo-twitter-card.png
description: "Understand Temporal more clearly through example applications and code samples."
---

![Example Applications](/img/banners/exampleapplications.png)
<h1>
<img alt="Example Applications" src="/img/banners/exampleapplications.png" />
</h1>

Explore example applications that use Temporal and gain a clearer understanding of how everything fits together.
Explore example applications and code samples that use Temporal and gain a clearer understanding of how everything fits together.

# Reference Applications
Reference Applications are fully documented, end-to-end solutions that show how to use Temporal for a particular use case. If you're new to Temporal, these are a great place to start to understand its capabilities.
## Reference applications

Reference applications are fully documented, end-to-end solutions that show how to use Temporal for a particular use case.
If you're new to Temporal, these are a great place to start to understand its capabilities.

* [Background Check Application in Go](go/background-checks/index.md)
* [Order Management System in Go](https://github.com/temporalio/reference-app-orders-go)

# Example applications
## Example applications

While not intended for production use, Example Applications can nonetheless be useful for seeing Temporal in action for particular use cases and architectural design patterns.

## Use cases
### Use cases

* **Order Fulfillment** [[TypeScript]](https://github.com/temporal-sa/temporal-order-fulfill-demo) A Temporal workflow for a sample e-commerce order fulfillment use case. This demo showcases Temporal's powerful durability and interactive capabilities. See companion [video](https://www.youtube.com/watch?v=dNVmRfWsNkM).
* **Money Transfer** [[Java]](https://github.com/temporal-sa/temporal-money-transfer-java) [[TypeScript]](https://github.com/temporal-sa/temporal-money-transfer-typescript) demonstrates core value propositions of Temporal. A custom UI allows users to choose from a number of simulated failure scenarios and use of Temporal primitives such as signals and schedules.
* **Orchestrate Lambda Functions** [[TypeScript]](https://github.com/temporal-sa/temporal-orchestrate-lambda-functions) A Temporal version of the [AWS Step Functions: Lambda orchestration example](https://docs.aws.amazon.com/step-functions/latest/dg/sample-lambda-orchestration.html) which uses Lambda functions to check a stock price and determine a buy or sell trading recommendation.

## Design patterns
### Design patterns

* **Entity Workflow demo** [[Go]](https://github.com/temporal-sa/temporal-entity-lifecycle-go) The purpose of this demo is to illustrate some of the interesting properties of the Entity Lifecycle Pattern (aka Entity Workflows). See companion slide deck on [Long-running workflows](https://docs.google.com/presentation/d/1A2dz4lFiIFz4c_7QlOpahbvesbBY8Y6y65zRrkVgqYE/edit?usp=sharing).
* **Order Saga sample** [[Java]](https://github.com/temporal-sa/temporal-order-saga) Demonstrates Temporal's enhanced support for the Saga pattern, supporting recovery from failed transactions. See this [companion video](https://www.youtube.com/watch?v=uHDQMfOMFD4) to see a demonstration of the example.

## Data encryption
### Data encryption

See the [Codec Server documentation](https://docs.temporal.io/production-deployment/data-encryption) for more information.
* **Codec Server with JWT validation** [[TypeScript]](https://github.com/temporal-sa/temporal-codec-server) The codec server uses JSON Web Tokens (JWT) to confirm the authenticity of JWTs issued by Temporal Cloud.
* **Codec CORS credentials** [[Go]](https://github.com/temporal-sa/codec-cors-credentials) An implementation of a Temporal [Codec Server](https://docs.temporal.io/dataconversion#codec-server) that supports Cross-Origin Resource Sharing (CORS), and specifically CORS requests with credentials.

# Samples
Samples are more targeted examples that showcase particular features of Temporal and/or support for various language features.
## Samples

Samples are more targeted examples that showcase particular Temporal features or common patterns.

* [Go SDK Samples](https://github.com/temporalio/samples-go)
* [Java SDK Samples](https://github.com/temporalio/samples-java)
* [Python SDK Samples](https://github.com/temporalio/samples-python)
* [TypeScript SDK Samples](https://github.com/temporalio/samples-typescript)
* [.NET SDK Samples](https://github.com/temporalio/samples-dotnet)
* [Go SDK samples](https://github.com/temporalio/samples-go)
* [Java SDK samples](https://github.com/temporalio/samples-java)
* [Python SDK samples](https://github.com/temporalio/samples-python)
* [TypeScript SDK samples](https://github.com/temporalio/samples-typescript)
* [.NET SDK samples](https://github.com/temporalio/samples-dotnet)

More examples coming soon.
4 changes: 3 additions & 1 deletion docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ image: /img/temporal-logo-twitter-card.png

import Link from '@docusaurus/Link';

![Get Started with Temporal](/img/banners/getstarted.png)
<h1>
<img alt="Get Started with Temporal" src="/img/banners/getstarted.png" />
</h1>

Take your first steps into building apps with Temporal by exploring how Temporal apps work.

Expand Down
11 changes: 9 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
slug: /
title: Home
title: Learn Temporal
sidebar_title: Home
hide_title: true
sidebar_position: 1
hide_table_of_contents: true
Expand All @@ -10,7 +11,13 @@ custom_edit_url: null
image: /img/temporal-logo-twitter-card.png
---

![Learn Temporal](/img/banners/learntemporal.png)
<head>
<title>Learn Temporal - Courses, Tutorials, and Examples</title>
</head>

<h1>
<img src="/img/banners/learntemporal.png" title="Learn Temporal" alt="Learn Temporal" />
</h1>

import Intro from '@site/src/components/Intro'

Expand Down
6 changes: 4 additions & 2 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Project-based Tutorials"
title: "Project-based tutorials"
hide_title: true
sidebar_position: 4
hide_table_of_contents: true
Expand All @@ -8,7 +8,9 @@ pagination_next: examples/index
image: /img/temporal-logo-twitter-card.png
---

![Project-based tutorials](/img/banners/projectbasedtutorials.png)
<h1>
<img alt="Project-based tutorials" src="/img/banners/projectbasetutorials.png" />
axfelix marked this conversation as resolved.
Show resolved Hide resolved
</h1>

Go beyond code samples and individual concepts as you practice building specific applications with Temporal with step-by-step tutorials.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/php/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "PHP tutorials"
sidebar_position: 4
keywords: [PHP,tutorial,temporal,workflows,laravel,roadrunner]
description: "Build Temporal applications with these PHP tutorials"
description: "Build Temporal applications with these PHP tutorials. Get started today."
image: /img/temporal-logo-twitter-card.png
---

Expand Down
5 changes: 2 additions & 3 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [
{type: 'autogenerated', dirName: '.'},
{type: 'link', label: "Dev guide", href: "https://docs.temporal.io/dev-guide/"},
{type: 'link', label: "Documentation", href: "https://docs.temporal.io"},
{type: 'link', label: "Forums", href: "https://community.temporal.io"},
{type: 'link', label: "Product documentation", href: "https://docs.temporal.io"},
{type: 'link', label: "Community forums", href: "https://community.temporal.io"},
],
};

Expand Down
Loading