Skip to content

Commit

Permalink
Deployment -> Service deployments
Browse files Browse the repository at this point in the history
(not everywhere)
  • Loading branch information
slinkydeveloper committed Dec 19, 2023
1 parent cb9eea6 commit b35a27c
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ and providing it with the deployment endpoint of the service `http://localhost:8
```shell
curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://localhost:9080"}'
```
Restate then sends a request to the deployment to ask which services and methods
Restate then sends a request to the service deployment to ask which services and methods
are running behind this deployment and will keep track of these (including of the method signatures).

Check notice on line 116 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L116

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 116, "column": 1}}}, "severity": "INFO"}

Check warning on line 116 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L116

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 116, "column": 40}}}, "severity": "WARNING"}

Check notice on line 116 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L116

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 116, "column": 65}}}, "severity": "INFO"}
After executing this curl request, you should see the discovered services and methods printed to your terminal.

Expand All @@ -134,7 +134,7 @@ and providing it with the deployment endpoint of the service `http://host.docker
```shell
curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://host.docker.internal:9080"}'
```
Restate then sends a request to the deployment to ask which services and methods
Restate then sends a request to the service deployment to ask which services and methods
are running behind this deployment and will keep track of these (including of the method signatures).

Check notice on line 138 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L138

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 138, "column": 1}}}, "severity": "INFO"}

Check warning on line 138 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L138

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 138, "column": 40}}}, "severity": "WARNING"}

Check notice on line 138 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L138

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 138, "column": 65}}}, "severity": "INFO"}
After executing this curl request, you should see the discovered services and methods printed to your terminal.

Expand Down
4 changes: 2 additions & 2 deletions docs/references/restate-sql-introspection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The schema of these tables is described in the following.
| `invoked_by` | `Utf8` | Enum describing the invoker of this service: `ingress` = invoked externally / `service` = invoked by a service. | |

Check failure on line 32 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L32

[Vale.Spelling] Did you really mean 'Enum'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Enum'?", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 32, "column": 39}}}, "severity": "ERROR"}
| `invoked_by_service` | `Utf8` | The name of the invoking service. Or `null` if invoked via the ingress. | `com.example.Greeter` |
| `invoked_by_id` | `Utf8` | The Invocation ID of the service that triggered this invocation. Or `null` if invoked externally. | |
| `pinned_deployment_id` | `Utf8` | The opaque deployment ID that has been committed for this invocation; this is set after the first journal entry is stored for this invocation. | |
| `pinned_deployment_id` | `Utf8` | The opaque service deployment ID that has been committed for this invocation; this is set after the first journal entry is stored for this invocation. | |

Check warning on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[write-good.Passive] 'been committed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'been committed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 81}}}, "severity": "WARNING"}

Check notice on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[write-good.E-Prime] Try to avoid using 'been'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'been'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 81}}}, "severity": "INFO"}

Check notice on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[Google.Passive] In general, use active voice instead of passive voice ('been committed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('been committed').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 81}}}, "severity": "INFO"}

Check warning on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 122}}}, "severity": "WARNING"}

Check notice on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 122}}}, "severity": "INFO"}

Check notice on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[Google.Passive] In general, use active voice instead of passive voice ('is set').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is set').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 122}}}, "severity": "INFO"}

Check warning on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[write-good.Passive] 'is stored' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is stored' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 159}}}, "severity": "WARNING"}

Check notice on line 35 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L35

[Google.Passive] In general, use active voice instead of passive voice ('is stored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is stored').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 35, "column": 159}}}, "severity": "INFO"}
| `trace_id` | `Utf8` | The ID of the trace that is assigned to this invocation. Only relevant when tracing is enabled. | |

Check notice on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[Google.Contractions] Use 'that's' instead of 'that is'.
Raw output
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 59}}}, "severity": "INFO"}

Check notice on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 64}}}, "severity": "INFO"}

Check warning on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[write-good.Passive] 'is assigned' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is assigned' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 64}}}, "severity": "WARNING"}

Check notice on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[Google.Passive] In general, use active voice instead of passive voice ('is assigned').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is assigned').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 64}}}, "severity": "INFO"}

Check warning on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[write-good.Weasel] 'Only' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'Only' is a weasel word!", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 96}}}, "severity": "WARNING"}

Check notice on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 123}}}, "severity": "INFO"}

Check notice on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[Google.Passive] In general, use active voice instead of passive voice ('is enabled').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is enabled').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 123}}}, "severity": "INFO"}

Check warning on line 36 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L36

[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 36, "column": 123}}}, "severity": "WARNING"}
| `journal_size` | `UInt32` | The number of journal entries durably logged for this invocation. | |
| `created_at` | `Date64` | Timestamp indicating the start of this invocation. | |
Expand All @@ -49,7 +49,7 @@ The schema of these tables is described in the following.
| `in_flight` | `Boolean` | Indicates whether there is currently an attempt running for this invocation. | |

Check notice on line 49 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L49

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 49, "column": 70}}}, "severity": "INFO"}

Check warning on line 49 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L49

[write-good.Weasel] 'currently' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'currently' is a weasel word!", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 49, "column": 73}}}, "severity": "WARNING"}
| `retry_count` | `UInt64` | The number of attempts since the last successful attempt of this invocation. Increments on start, so 2 or more means a failure occurred. | |
| `last_start_at` | `Date64` | Timestamp indicating the start of the most recent attempt of this invocation. | |
| `last_attempt_deployment_id` | `Utf8` | The opaque deployment ID that was used in the most recent attempt of this invocation; this will be set before a journal entry is stored, but can change later. | |
| `last_attempt_deployment_id` | `Utf8` | The opaque service deployment ID that was used in the most recent attempt of this invocation; this will be set before a journal entry is stored, but can change later. | |

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[Google.Passive] In general, use active voice instead of passive voice ('was used').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was used').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 84}}}, "severity": "INFO"}

Check warning on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.Passive] 'was used' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'was used' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 84}}}, "severity": "WARNING"}

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.E-Prime] Try to avoid using 'was'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'was'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 84}}}, "severity": "INFO"}

Check warning on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 145}}}, "severity": "WARNING"}

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[Google.Passive] In general, use active voice instead of passive voice ('be set').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be set').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 150}}}, "severity": "INFO"}

Check warning on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.Passive] 'be set' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be set' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 150}}}, "severity": "WARNING"}

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 150}}}, "severity": "INFO"}

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[Google.Passive] In general, use active voice instead of passive voice ('is stored').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is stored').", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 180}}}, "severity": "INFO"}

Check notice on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 180}}}, "severity": "INFO"}

Check warning on line 52 in docs/references/restate-sql-introspection.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/references/restate-sql-introspection.mdx#L52

[write-good.Passive] 'is stored' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is stored' may be passive voice. Use active voice if you can.", "location": {"path": "docs/references/restate-sql-introspection.mdx", "range": {"start": {"line": 52, "column": 180}}}, "severity": "WARNING"}
| `next_retry_at` | `Date64` | Timestamp indicating the start of the next attempt of this invocation. | |
| `last_failure` | `Utf8` | An error message describing the most recent failed attempt of this invocation, if any. | |
| `last_error_code` | `Utf8` | The [error code](./errors) of the most recent failed attempt of this invocation, if any. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/restate/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ It exposes three services by default, each on different ports:
| Name | Port | Description | Protocol |
|----------|------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| Ingress | 8080 | Acts as an API gateway for all services registered with Restate | gRPC + [Connect Protocol](https://connect.build/) |
| Admin | 9070 | Allows for CRUD operations on service/deployment metadata, eg for service registration | REST |
| Admin | 9070 | Allows for CRUD operations on service/service deployment metadata, eg for service registration | REST |

Check notice on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14

[Google.Acronyms] Spell out 'CRUD', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'CRUD', if it's unfamiliar to the audience.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 32}}}, "severity": "INFO"}

Check failure on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14

[Vale.Spelling] Did you really mean 'eg'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'eg'?", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 88}}}, "severity": "ERROR"}

Check failure on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14

[Google.Latin] Use 'for example' instead of 'eg'.
Raw output
{"message": "[Google.Latin] Use 'for example' instead of 'eg'.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 88}}}, "severity": "ERROR"}

Check notice on line 14 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/deployment.md#L14

[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 14, "column": 150}}}, "severity": "INFO"}
| Postgres | 9071 | Exposes Restate RocksDB read-only storage operations using the Postgres protocol. See [Introspection](/services/introspection) | Postgres |

It will store metadata and RocksDB data in the relative directory of /target under the current working directory of the process.
Expand Down
2 changes: 1 addition & 1 deletion docs/restate/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following components are producing relevant logs:

* `restate_ingress_grpc`: The component ingesting gRPC/Connect HTTP requests inside Restate
* `restate_meta`: The component responsible for holding the metadata informations and executing service discovery
* `restate_invoker`: The component interacting with deployed deployments
* `restate_invoker`: The component interacting with deployed service deployments
* `restate_worker::partition::state_machine`: The state machine effects
* `restate_storage`: Restate storage layer
* `hyper`: The HTTP library
Expand Down
1 change: 1 addition & 0 deletions docs/restate/managed_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ Resource Policies, or you can create a role per account - Restate can assume a d

Once you have a role that has permission to call the Lambda, and allows Restate to assume it, you just need to discover
the Lambda:

```shell
curl -X POST http://<your-restate-runtime-endpoint>:9070/deployments -H 'content-type: application/json' -d '{"arn": "<lambda-function-arn>", "assume_role_arn": "<role-arn>" }'
```
2 changes: 1 addition & 1 deletion docs/restate/tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The traces contain detailed information about the context calls that were done d

![Understanding traces](/img/jaeger_tour_background_call_handler.png)

The initial `ingress_invoke` spans show when the gRPC/Connect HTTP request was received by Restate. The `invoke` span beneath it shows when Restate invoked the deployment to process the request.
The initial `ingress_invoke` spans show when the gRPC/Connect HTTP request was received by Restate. The `invoke` span beneath it shows when Restate invoked the service deployment to process the request.

Check warning on line 89 in docs/restate/tracing.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/tracing.mdx#L89

[write-good.Passive] 'was received' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'was received' may be passive voice. Use active voice if you can.", "location": {"path": "docs/restate/tracing.mdx", "range": {"start": {"line": 89, "column": 76}}}, "severity": "WARNING"}

Check notice on line 89 in docs/restate/tracing.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/tracing.mdx#L89

[write-good.E-Prime] Try to avoid using 'was'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'was'.", "location": {"path": "docs/restate/tracing.mdx", "range": {"start": {"line": 89, "column": 76}}}, "severity": "INFO"}

Check notice on line 89 in docs/restate/tracing.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/restate/tracing.mdx#L89

[Google.Passive] In general, use active voice instead of passive voice ('was received').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was received').", "location": {"path": "docs/restate/tracing.mdx", "range": {"start": {"line": 89, "column": 76}}}, "severity": "INFO"}

The tags of the spans contain the metadata of the context calls (e.g. call arguments, invocation id).

Expand Down
6 changes: 3 additions & 3 deletions docs/services/deployment/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: "Learn how to deploy Restate services."

# General

Restate services are deployed within *Deployments*. The Restate runtime interacts with deployments by sending requests to them using a custom protocol on top of HTTP.
Restate services are deployed within *Service deployments*. The Restate runtime interacts with service deployments by sending requests to them using a custom protocol on top of HTTP.

Check warning on line 8 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L8

[write-good.Passive] 'are deployed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are deployed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 8, "column": 18}}}, "severity": "WARNING"}

Check notice on line 8 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L8

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 8, "column": 18}}}, "severity": "INFO"}

Check notice on line 8 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L8

[Google.Passive] In general, use active voice instead of passive voice ('are deployed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are deployed').", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 8, "column": 18}}}, "severity": "INFO"}

A deployment can be a Lambda function, a Kubernetes pod, a Knative Service, or any other process reachable at a specific URL.
A service deployment can be a Lambda function, a Kubernetes pod, a Knative Service, or any other process reachable at a specific URL.

Check notice on line 10 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L10

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 10, "column": 26}}}, "severity": "INFO"}

Check failure on line 10 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L10

[Vale.Spelling] Did you really mean 'Knative'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Knative'?", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 10, "column": 68}}}, "severity": "ERROR"}

The URL (including path prefix) MUST be **unique**, meaning that no two deployments with the same URL can exist at the same time in a Restate instance.

Check notice on line 12 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L12

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 12, "column": 9}}}, "severity": "INFO"}

Check notice on line 12 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L12

[Google.Acronyms] Spell out 'MUST', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'MUST', if it's unfamiliar to the audience.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 12, "column": 33}}}, "severity": "INFO"}

Check notice on line 12 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L12

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 12, "column": 38}}}, "severity": "INFO"}

Moreover, deployments are **immutable**, and are assumed to be reachable throughout the entire lifecycle of an invocation. To deploy any change to a service, either in the Protobuf definition or in the business logic, you should deploy a new deployment with a new URL. See the [versioning documentation](/services/upgrades-removal) for more details on how to update services.
Moreover, service deployments are **immutable**, and are assumed to be reachable throughout the entire lifecycle of an invocation. To deploy any change to a service, either in the Protobuf definition or in the business logic, you should deploy a new deployment with a new URL. See the [versioning documentation](/services/upgrades-removal) for more details on how to update services.

Check notice on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 31}}}, "severity": "INFO"}

Check warning on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[write-good.Passive] 'are assumed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are assumed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 54}}}, "severity": "WARNING"}

Check notice on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 54}}}, "severity": "INFO"}

Check notice on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[Google.Passive] In general, use active voice instead of passive voice ('are assumed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are assumed').", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 54}}}, "severity": "INFO"}

Check notice on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 69}}}, "severity": "INFO"}

Check failure on line 14 in docs/services/deployment/general.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/general.md#L14

[Vale.Spelling] Did you really mean 'Protobuf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Protobuf'?", "location": {"path": "docs/services/deployment/general.md", "range": {"start": {"line": 14, "column": 181}}}, "severity": "ERROR"}


:::info Running services locally
Expand Down
6 changes: 3 additions & 3 deletions docs/services/deployment/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: "Learn how to run Restate applications on Kubernetes."

# Kubernetes

Deployments can be deployed like any gRPC service; a Deployment of more than one replica is generally appropriate. However,
like gRPC services, they must be appropriately load balanced at L7 if you want multiple deployment pods. Native Kubernetes
Service deployments can be deployed like any gRPC service; a Deployment of more than one replica is generally appropriate. However,

Check notice on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[Google.Passive] In general, use active voice instead of passive voice ('be deployed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be deployed').", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 25}}}, "severity": "INFO"}

Check warning on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[write-good.Passive] 'be deployed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be deployed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 25}}}, "severity": "WARNING"}

Check notice on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 25}}}, "severity": "INFO"}

Check notice on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[Google.Semicolons] Use semicolons judiciously.
Raw output
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 58}}}, "severity": "INFO"}

Check notice on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 98}}}, "severity": "INFO"}

Check warning on line 8 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L8

[write-good.TooWordy] 'However' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'However' is too wordy.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 8, "column": 124}}}, "severity": "WARNING"}
like gRPC services, they must be appropriately load balanced at L7 if you want multiple service deployment pods. Native Kubernetes

Check notice on line 9 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L9

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 9, "column": 31}}}, "severity": "INFO"}

Check warning on line 9 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L9

[write-good.TooWordy] 'multiple' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'multiple' is too wordy.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 9, "column": 80}}}, "severity": "WARNING"}
ClusterIP load balancing will lead to the Restate binary sending all requests to a single pod, as HTTP2 connections
are aggressively reused. This is fine for local testing, but in production an approach must be found. If your
infrastructure already has an approach for L7 load balancing gRPC services, you can use the same approach here.
Expand Down Expand Up @@ -66,7 +66,7 @@ L7 load balancing is not needed when there is only one pod, so it's acceptable t
## Knative
Restate supports Knative services. Knative allows scaling to zero when there are no in-flight invocations and automatically configures an L7 load balancer. There are no special requirements to deploy a deployment container with Knative:
Restate supports Knative services. Knative allows scaling to zero when there are no in-flight invocations and automatically configures an L7 load balancer. There are no special requirements to deploy a service deployment container with Knative:

Check failure on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[Vale.Spelling] Did you really mean 'Knative'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Knative'?", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 18}}}, "severity": "ERROR"}

Check failure on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[Vale.Spelling] Did you really mean 'Knative'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Knative'?", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 36}}}, "severity": "ERROR"}

Check notice on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 78}}}, "severity": "INFO"}

Check failure on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 157}}}, "severity": "ERROR"}

Check notice on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 163}}}, "severity": "INFO"}

Check failure on line 69 in docs/services/deployment/kubernetes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/deployment/kubernetes.md#L69

[Vale.Spelling] Did you really mean 'Knative'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Knative'?", "location": {"path": "docs/services/deployment/kubernetes.md", "range": {"start": {"line": 69, "column": 237}}}, "severity": "ERROR"}
```shell
$ kn service create service-name --port h2c:9080 --image path.to/yourrepo:yourtag
Expand Down
2 changes: 1 addition & 1 deletion docs/services/introspection.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ This following list contains some key queries on the `sys_status` table to give

## Inspecting the attempt status of an invocation

Invocations can be attempted against a deployment many times if the endpoint is failing. The metadata around
Invocations can be attempted against a service deployment many times if the endpoint is failing. The metadata around

Check notice on line 93 in docs/services/introspection.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/introspection.md#L93

[Google.Passive] In general, use active voice instead of passive voice ('be attempted').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be attempted').", "location": {"path": "docs/services/introspection.md", "range": {"start": {"line": 93, "column": 17}}}, "severity": "INFO"}

Check warning on line 93 in docs/services/introspection.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/introspection.md#L93

[write-good.Passive] 'be attempted' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be attempted' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/introspection.md", "range": {"start": {"line": 93, "column": 17}}}, "severity": "WARNING"}

Check notice on line 93 in docs/services/introspection.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/introspection.md#L93

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/introspection.md", "range": {"start": {"line": 93, "column": 17}}}, "severity": "INFO"}

Check warning on line 93 in docs/services/introspection.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/introspection.md#L93

[write-good.Weasel] 'many' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'many' is a weasel word!", "location": {"path": "docs/services/introspection.md", "range": {"start": {"line": 93, "column": 59}}}, "severity": "WARNING"}

Check notice on line 93 in docs/services/introspection.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/introspection.md#L93

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/introspection.md", "range": {"start": {"line": 93, "column": 86}}}, "severity": "INFO"}
these attempts is not committed durably to storage, but is held in memory in the `invoker` component. The metadata
includes reasons that an attempt might be failing, for example a permission error calling a Lambda endpoint.

Expand Down
2 changes: 1 addition & 1 deletion docs/services/invocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This feature can be especially useful when you need to invoke a service method i

## Private services

When registering a deployment, every service is by default accessible both by other services, and by sending requests to Restate using HTTP and/or gRPC. You can configure a service as `private`, such that you can't invoke it by sending requests to Restate, through the [Admin APIs](/references/admin-api):
When registering a service deployment, every service is by default accessible both by other services, and by sending requests to Restate using HTTP and/or gRPC. You can configure a service as `private`, such that you can't invoke it by sending requests to Restate, through the [Admin APIs](/references/admin-api):

Check notice on line 105 in docs/services/invocation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/invocation.md#L105

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/invocation.md", "range": {"start": {"line": 105, "column": 54}}}, "severity": "INFO"}

Check failure on line 105 in docs/services/invocation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/invocation.md#L105

[Vale.Spelling] Did you really mean 'APIs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'APIs'?", "location": {"path": "docs/services/invocation.md", "range": {"start": {"line": 105, "column": 285}}}, "severity": "ERROR"}
```shell
$ curl -X PATCH <RESTATE_META_ENDPOINT>/services/<SERVICE_NAME> -H 'content-type: application/json' -d '{"public": false}'
Expand Down
4 changes: 2 additions & 2 deletions docs/services/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ After deploying a service deployment, in order to use it, it must be registered
$ curl <RESTATE_META_ENDPOINT>/deployments --json '{"uri": "<SERVICE_ENDPOINT_URI>"}'
```

When registering a deployment, Restate uses a mechanism similar to "reflections" to discover the available services and their schemas and properties. A service can be registered only once, and subsequent registration requests to the same deployment will fail. For more details on how to update services, check the [versioning documentation](/services/upgrades-removal).
When registering a service deployment, Restate uses a mechanism similar to "reflections" to discover the available services and their schemas and properties. A service can be registered only once, and subsequent registration requests to the same deployment will fail. For more details on how to update services, check the [versioning documentation](/services/upgrades-removal).

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[write-good.TooWordy] 'similar to' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'similar to' is too wordy.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 65}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[write-good.Passive] 'be registered' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be registered' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 173}}}, "severity": "WARNING"}

Check notice on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 173}}}, "severity": "INFO"}

Check notice on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[Google.Passive] In general, use active voice instead of passive voice ('be registered').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be registered').", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 173}}}, "severity": "INFO"}

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[write-good.Weasel] 'only' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'only' is a weasel word!", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 187}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[write-good.TooWordy] 'subsequent' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'subsequent' is too wordy.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 202}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 258}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L14

[Google.WordList] Use 'select' instead of 'check'.
Raw output
{"message": "[Google.WordList] Use 'select' instead of 'check'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 14, "column": 313}}}, "severity": "WARNING"}

The deployment creation can be forced to overwrite an existing deployment using curl (>v7.82.0):

Check notice on line 16 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L16

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 16, "column": 29}}}, "severity": "INFO"}

Check warning on line 16 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L16

[write-good.Passive] 'be forced' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be forced' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 16, "column": 29}}}, "severity": "WARNING"}

Check notice on line 16 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L16

[Google.Passive] In general, use active voice instead of passive voice ('be forced').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be forced').", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 16, "column": 29}}}, "severity": "INFO"}

Check notice on line 16 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L16

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 16, "column": 86}}}, "severity": "INFO"}

```bash
$ curl <RESTATE_META_ENDPOINT>/deployments --json '{"uri": "<SERVICE_ENDPOINT_URI>", "force": true}'
```

This will forcefully overwrite the existing deployment with the same uri, forcing the discovery process again. It will also remove services that were served by that deployment and are not available anymore.
This will forcefully overwrite the existing service deployment with the same uri, forcing the discovery process again. It will also remove services that were served by that deployment and are not available anymore.

Check warning on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 6}}}, "severity": "WARNING"}

Check failure on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[Vale.Spelling] Did you really mean 'uri'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'uri'?", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 78}}}, "severity": "ERROR"}

Check warning on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 123}}}, "severity": "WARNING"}

Check notice on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[write-good.E-Prime] Try to avoid using 'were'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'were'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 154}}}, "severity": "INFO"}

Check warning on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[write-good.Passive] 'were served' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'were served' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 154}}}, "severity": "WARNING"}

Check notice on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[Google.Passive] In general, use active voice instead of passive voice ('were served').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('were served').", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 154}}}, "severity": "INFO"}

Check notice on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[Google.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Google.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 189}}}, "severity": "INFO"}

Check notice on line 22 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L22

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 22, "column": 189}}}, "severity": "INFO"}

:::warning
Forcing a deployment registration is a feature designed to simplify local Restate service development, and should never be used in a production Restate deployment, as it potentially breaks all the in-flight invocations to that deployment.

Check notice on line 25 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L25

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 25, "column": 35}}}, "severity": "INFO"}

Check notice on line 25 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L25

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 25, "column": 121}}}, "severity": "INFO"}

Check notice on line 25 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L25

[Google.Passive] In general, use active voice instead of passive voice ('be used').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be used').", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 25, "column": 121}}}, "severity": "INFO"}

Check warning on line 25 in docs/services/registration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/registration.md#L25

[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/registration.md", "range": {"start": {"line": 25, "column": 121}}}, "severity": "WARNING"}
Expand Down
2 changes: 1 addition & 1 deletion docs/services/sdk/durable-timers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ctx.sleep(Duration.ofSeconds(10));
</Tabs>

:::note
For sleep to work properly, make sure that the system clock of the runtime is synchronized with the clock of the deployment and that they use the same time zone. When you do a timer-based action with the SDK (e.g. sleep, delayed calls), the duration gets calculated based on the system clock of the service. But subsequently, Restate registers this timer on its own system clock. So the system clock of the service and of Restate need to be synchronized.
For sleep to work properly, make sure that the system clock of the runtime is synchronized with the clock of the service deployment and that they use the same time zone. When you do a timer-based action with the SDK (e.g. sleep, delayed calls), the duration gets calculated based on the system clock of the service. But subsequently, Restate registers this timer on its own system clock. So the system clock of the service and of Restate need to be synchronized.

Check notice on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 76}}}, "severity": "INFO"}

Check warning on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[write-good.Passive] 'is synchronized' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is synchronized' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 76}}}, "severity": "WARNING"}

Check notice on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[Google.Passive] In general, use active voice instead of passive voice ('is synchronized').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is synchronized').", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 76}}}, "severity": "INFO"}

Check notice on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 217}}}, "severity": "INFO"}

Check failure on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw output
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 218}}}, "severity": "ERROR"}

Check failure on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[write-good.So] Don't start a sentence with 'So '.
Raw output
{"message": "[write-good.So] Don't start a sentence with 'So '.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 389}}}, "severity": "ERROR"}

Check warning on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[write-good.Passive] 'be synchronized' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be synchronized' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 447}}}, "severity": "WARNING"}

Check notice on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 447}}}, "severity": "INFO"}

Check notice on line 40 in docs/services/sdk/durable-timers.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/sdk/durable-timers.mdx#L40

[Google.Passive] In general, use active voice instead of passive voice ('be synchronized').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be synchronized').", "location": {"path": "docs/services/sdk/durable-timers.mdx", "range": {"start": {"line": 40, "column": 447}}}, "severity": "INFO"}
:::

:::caution
Expand Down
2 changes: 1 addition & 1 deletion docs/services/service_type.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,4 @@ Once you have the contract, the SDK uses it to generate the code to encode/decod

The contract can also be used to generate gRPC/Connect clients to invoke Restate services from your webapp, mobile app, legacy system or in general from any system outside Restate services. Have a look at the [invocation docs](/services/invocation). You can check out the [gRPC](https://grpc.io/docs/languages/) and [Connect](https://connect.build/docs/introduction) documentation for more info on the available clients.

When [registering a deployment](/services/registration), Restate automatically _discovers_ all the available service contracts and stores them in an internal registry, no manual input is needed.
When [registering a service deployment](/services/registration), Restate automatically _discovers_ all the available service contracts and stores them in an internal registry, no manual input is needed.

Check warning on line 177 in docs/services/service_type.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/service_type.mdx#L177

[write-good.Passive] 'is needed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is needed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/service_type.mdx", "range": {"start": {"line": 177, "column": 193}}}, "severity": "WARNING"}

Check notice on line 177 in docs/services/service_type.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/service_type.mdx#L177

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "docs/services/service_type.mdx", "range": {"start": {"line": 177, "column": 193}}}, "severity": "INFO"}

Check notice on line 177 in docs/services/service_type.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/service_type.mdx#L177

[Google.Passive] In general, use active voice instead of passive voice ('is needed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is needed').", "location": {"path": "docs/services/service_type.mdx", "range": {"start": {"line": 177, "column": 193}}}, "severity": "INFO"}
2 changes: 1 addition & 1 deletion docs/services/upgrades-removal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Restate comes with different solutions to update the services, to simplify devel

## Deploy a new service revision

As described in the [deployment documentation](/services/deployment/general), *deployments* are immutable, and are assumed to be reachable throughout the entire lifecycle of an invocation. In order to deploy any change to a service, either in the protobuf definition and/or in the business logic, a new deployment should be deployed and registered.
As described in the [deployment documentation](/services/deployment/general), *service deployments* are immutable, and are assumed to be reachable throughout the entire lifecycle of an invocation. In order to deploy any change to a service, either in the protobuf definition and/or in the business logic, a new deployment should be deployed and registered.

Check notice on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 101}}}, "severity": "INFO"}

Check notice on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 120}}}, "severity": "INFO"}

Check notice on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[Google.Passive] In general, use active voice instead of passive voice ('are assumed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are assumed').", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 120}}}, "severity": "INFO"}

Check warning on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.Passive] 'are assumed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are assumed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 120}}}, "severity": "WARNING"}

Check notice on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 135}}}, "severity": "INFO"}

Check warning on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.TooWordy] 'In order to' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'In order to' is too wordy.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 198}}}, "severity": "WARNING"}

Check failure on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[Vale.Spelling] Did you really mean 'protobuf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'protobuf'?", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 256}}}, "severity": "ERROR"}

Check warning on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[write-good.Passive] 'be deployed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be deployed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 330}}}, "severity": "WARNING"}

Check notice on line 12 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L12

[Google.Passive] In general, use active voice instead of passive voice ('be deployed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be deployed').", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 12, "column": 330}}}, "severity": "INFO"}

When registering a new deployment, Restate will detect if it contains already registered services, and will treat them as new revisions. Any new invocations to that service will be executed by the newly registered deployment, thus guaranteeing that new invocations are always routed to the latest service revision, while *old* invocations will continue to use the previous deployment. It must be guaranteed that the old deployment lives until all the existing invocations complete.

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 44}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 104}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 174}}}, "severity": "WARNING"}

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[write-good.Passive] 'be executed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be executed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 179}}}, "severity": "WARNING"}

Check notice on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Passive] In general, use active voice instead of passive voice ('be executed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be executed').", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 179}}}, "severity": "INFO"}

Check notice on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 179}}}, "severity": "INFO"}

Check notice on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 266}}}, "severity": "INFO"}

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 340}}}, "severity": "WARNING"}

Check notice on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[Google.Passive] In general, use active voice instead of passive voice ('be guaranteed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be guaranteed').", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 394}}}, "severity": "INFO"}

Check warning on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[write-good.Passive] 'be guaranteed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be guaranteed' may be passive voice. Use active voice if you can.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 394}}}, "severity": "WARNING"}

Check notice on line 14 in docs/services/upgrades-removal.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/services/upgrades-removal.md#L14

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "docs/services/upgrades-removal.md", "range": {"start": {"line": 14, "column": 394}}}, "severity": "INFO"}

Expand Down
2 changes: 1 addition & 1 deletion docs/tour.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ curl -X POST http://localhost:9070/deployments -H 'content-type: application/jso
</TabItem>
</Tabs>

Restate will send a discovery request to the deployment to find the services and methods run behind this endpoint. Restate keeps track of which services run where (including of the method signatures). Restate also keeps track of multiple revisions as your APIs evolve, and routes requests appropriately.
Restate will send a discovery request to the service deployment to find the services and methods run behind this endpoint. Restate keeps track of which services run where (including of the method signatures). Restate also keeps track of multiple revisions as your APIs evolve, and routes requests appropriately.

Check warning on line 174 in docs/tour.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/tour.mdx#L174

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/tour.mdx", "range": {"start": {"line": 174, "column": 9}}}, "severity": "WARNING"}

Check notice on line 174 in docs/tour.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/tour.mdx#L174

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/tour.mdx", "range": {"start": {"line": 174, "column": 172}}}, "severity": "INFO"}

Check warning on line 174 in docs/tour.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/tour.mdx#L174

[write-good.TooWordy] 'multiple' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'multiple' is too wordy.", "location": {"path": "docs/tour.mdx", "range": {"start": {"line": 174, "column": 238}}}, "severity": "WARNING"}

Check failure on line 174 in docs/tour.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/tour.mdx#L174

[Vale.Spelling] Did you really mean 'APIs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'APIs'?", "location": {"path": "docs/tour.mdx", "range": {"start": {"line": 174, "column": 265}}}, "severity": "ERROR"}

:::tip
You can pipe the output of `curl` into the `jq` utility to reformat the JSON output and make it easier to read.
Expand Down

0 comments on commit b35a27c

Please sign in to comment.