From 7d4c79091324791b6720b77a7ca5a2ba2bdeca9a Mon Sep 17 00:00:00 2001 From: Giselle van Dongen Date: Mon, 18 Dec 2023 11:19:46 +0100 Subject: [PATCH] Use TypeScript instead of Typescript --- .github/workflows/pre-release.yml | 2 +- README.md | 4 ++-- docs/restate/managed_service.md | 2 +- docs/services/sdk/kafka.mdx | 2 +- docs/services/sdk/overview.mdx | 12 ++++++------ docs/services/service_type.mdx | 2 +- docusaurus.config.js | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml index 4573eaf7..fc5e0442 100644 --- a/.github/workflows/pre-release.yml +++ b/.github/workflows/pre-release.yml @@ -16,7 +16,7 @@ on: required: false type: string tourVersion: - description: "Typescript+Java tour version (without prepending v)." + description: "TypeScript+Java tour version (without prepending v)." required: false type: string diff --git a/README.md b/README.md index dfbc46c4..eb235958 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ $ ./tools/generate.sh The config file `restate.config.json` contains versions of various Restate artifacts: -* Typescript SDK: `TYPESCRIPT_SDK_VERSION` +* TypeScript SDK: `TYPESCRIPT_SDK_VERSION` * Java SDK: `JAVA_SDK_VERSION` * Runtime: `RESTATE_VERSION` -* Tour: `TOUR_VERSION` (This counts for the Typescript and Java Tour). +* Tour: `TOUR_VERSION` (This counts for the TypeScript and Java Tour). diff --git a/docs/restate/managed_service.md b/docs/restate/managed_service.md index 42f70231..b8c3681f 100644 --- a/docs/restate/managed_service.md +++ b/docs/restate/managed_service.md @@ -22,7 +22,7 @@ There are several API endpoints at this hostname: ### Registering services (8081) A Restate meta endpoint, which can be used to register Restate Lambda functions written in -[Typescript](/services/deployment/lambda/lambda-typescript#discovering-the-services-behind-the-lambda-endpoint) and [Java](/services/deployment/lambda/lambda-java#discovering-the-services-behind-the-lambda-endpoint), +[TypeScript](/services/deployment/lambda/lambda-typescript#discovering-the-services-behind-the-lambda-endpoint) and [Java](/services/deployment/lambda/lambda-java#discovering-the-services-behind-the-lambda-endpoint), with a bearer token set. ```bash curl -H "Authorization: Bearer $(cat /token)" https://yourcluster.dev.restate.cloud:8081/endpoints -H 'content-type: application/json' -d '{"uri": "https:///default/my-greeter", "additional_headers": {"x-api-key": "your-api-key"} }' diff --git a/docs/services/sdk/kafka.mdx b/docs/services/sdk/kafka.mdx index 4c21407d..373f57f9 100644 --- a/docs/services/sdk/kafka.mdx +++ b/docs/services/sdk/kafka.mdx @@ -23,7 +23,7 @@ Kafka support is in development, and it isn't ready for production usage. Next r Depending on your use case you can build different types of event handlers. We distinguish between the following scenarios: * Handle events with a string key from Kafka in Restate services keyed with a `string` key. -* Process generic events from Kafka in order (currently only supported by the Typescript gRPC API and the Java API.) +* Process generic events from Kafka in order (currently only supported by the TypeScript gRPC API and the Java API.) An event handlers can profit from the same features as other Restate handlers, including durable execution, [service communication](/services/sdk/service-communication) and [side effects](/services/sdk/side-effects). diff --git a/docs/services/sdk/overview.mdx b/docs/services/sdk/overview.mdx index beb6b96a..09301666 100644 --- a/docs/services/sdk/overview.mdx +++ b/docs/services/sdk/overview.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 1 -description: "Get an idea of what a Restate Typescript service looks like." +description: "Get an idea of what a Restate TypeScript service looks like." --- import Tabs from '@theme/Tabs'; @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; # Overview -Restate offers a Java SDK ([sdk-java repo](https://github.com/restatedev/sdk-java)) and a Typescript SDK ([sdk-typescript repo](https://github.com/restatedev/sdk-typescript)). +Restate offers a Java SDK ([sdk-java repo](https://github.com/restatedev/sdk-java)) and a TypeScript SDK ([sdk-typescript repo](https://github.com/restatedev/sdk-typescript)). ## Installation @@ -23,7 +23,7 @@ To get started quickly, use the [template generator](https://github.com/restated Add the `@restatedev/restate-sdk` dependency to your NodeJS project to start developing Restate services. :::info -Restate currently supports two Typescript APIs for implementing services: the Handler API and the gRPC API. +Restate currently supports two TypeScript APIs for implementing services: the Handler API and the gRPC API. The gRPC API requires you to specify the services, methods and data types via a Protobuf definition, as explained in the [service contract docs](/services/service_type#restate-service-contract). The Handler API does not require this. ::: @@ -104,7 +104,7 @@ For Maven you can use the [xolstice Protobuf plugin](https://www.xolstice.org/pr -Below is an example of a Typescript service with the Handler API. +Below is an example of a TypeScript service with the Handler API. This example shows a greeter service comprising two methods: - `greet`: returns a greeting as a response without performing any additional operations. @@ -147,9 +147,9 @@ For more information on how to set up the routers and the Restate server, have a -Below is an example of a Typescript gRPC service. +Below is an example of a TypeScript gRPC service. -The [gRPC](https://grpc.io/) API uses the `protobufjs` and `ts-proto` dependencies to work with the [Protobuf](https://protobuf.dev/)-generated Typescript code. So add these as well to your `package.json`. +The [gRPC](https://grpc.io/) API uses the `protobufjs` and `ts-proto` dependencies to work with the [Protobuf](https://protobuf.dev/)-generated TypeScript code. So add these as well to your `package.json`. This example shows a greeter service comprising two methods: - `greet`: returns a greeting as a response without performing any additional operations. diff --git a/docs/services/service_type.mdx b/docs/services/service_type.mdx index 32898673..d4b66637 100644 --- a/docs/services/service_type.mdx +++ b/docs/services/service_type.mdx @@ -31,7 +31,7 @@ A common use case for keyed services is to model an entity of your application. Because keyed services are executed serially on a per-key basis, it means that invocations will execute in the same order in which they are enqueued. For example, assume the following code in `ServiceA`: - + ```typescript const client = new ServiceB(ctx); diff --git a/docusaurus.config.js b/docusaurus.config.js index 466d6e79..26032b58 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -90,7 +90,7 @@ const config = { items: [ { href: "/services/sdk/overview?sdk=ts", - label: "Typescript SDK", + label: "TypeScript SDK", position: "right", }, {