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

Reorganize docs #5535

Merged
merged 6 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Don't hide assets folder
  • Loading branch information
MichaelSnowden committed Mar 18, 2024
commit bf011f734b7abf303ffe85d00a7aedb2438c2f9c
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.DEFAULT_GOAL := update-diagrams
COLOR := "\e[1;36m%s\e[0m\n"
DIAGRAMS := $(wildcard ./docs/.assets/*.d2)
DIAGRAMS := $(wildcard ./docs/_assets/*.d2)

install-d2:
@printf $(COLOR) "Install d2..."
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following are some fundamental premises:
These premises have led to a system architecture which is divided into user-hosted processes, versus the Temporal cluster processes (which may be hosted outside the user's systems):

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="assets/temporal-high-level.svg">
<img src="_assets/temporal-high-level.svg">

### User-hosted processes

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following are some fundamental premises:
These premises have led to a system architecture which is divided into user-hosted processes, versus the Temporal cluster processes (which may be hosted outside the user's systems):

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="../.assets/temporal-high-level.svg">
<img src="../_assets/temporal-high-level.svg">

### User-hosted processes

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/history-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page is an introduction to the History Service architecture and internal im
See [Temporal overview](./README.md) for a system architecture overview placing this in context.

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="../.assets/temporal-high-level.svg">
<img src="../_assets/temporal-high-level.svg">

The History Service handles two main types of request (gRPC) relating to an individual Workflow Execution:

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/matching-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[see [API definition](https://github.com/temporalio/temporal/blob/main/proto/internal/temporal/server/api/matchingservice/v1/service.proto)]

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="../.assets/matching-context.svg">
<img src="../_assets/matching-context.svg">

Matching Service instances manage [Task Queues](https://docs.temporal.io/workers#task-queue) being polled by Temporal Worker processes.
Long-poll requests from Temporal Workers are received by the Frontend Service, which routes them to the Matching Service instance responsible for the requested Task Queue.
Expand Down
2 changes: 1 addition & 1 deletion docs/history-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page is an introduction to the History Service architecture and internal im
See [Temporal overview](./README.md) for a system architecture overview placing this in context.

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="./assets/temporal-high-level.svg">
<img src="./_assets/temporal-high-level.svg">

The History Service handles two main types of request (gRPC) relating to an individual Workflow Execution:

Expand Down
2 changes: 1 addition & 1 deletion docs/matching-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[see [API definition](https://github.com/temporalio/temporal/blob/main/proto/internal/temporal/server/api/matchingservice/v1/service.proto)]

<!-- https://lucid.app/lucidchart/0202e4b8-5258-4cd6-a6a0-67159300532b/edit -->
<img src="./assets/matching-context.svg">
<img src="./_assets/matching-context.svg">

Matching Service instances manage [Task Queues](https://docs.temporal.io/workers#task-queue) being polled by Temporal Worker processes.
Long-poll requests from Temporal Workers are received by the Frontend Service, which routes them to the Matching Service instance responsible for the requested Task Queue.
Expand Down
Loading