Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Document binary artifacts #243

Merged
merged 2 commits into from
Jan 3, 2024
Merged

Document binary artifacts #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66d3a4b
Document binary artifacts
jackkleeman Jan 2, 2024
d8bd696
Add tips to quickstart re how to run
jackkleeman Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@
are running behind this deployment and will keep track of these (including of the method signatures).
After executing this curl request, you should see the discovered services and methods printed to your terminal.

:::tip
Restate is a single self-contained binary and Docker just one of the ways to run it. You can also obtain the binary from the

Check notice on line 120 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L120 

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

Check warning on line 120 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L120 

[write-good.TooWordy] 'obtain' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'obtain' is too wordy.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 120, "column": 99}}}, "severity": "WARNING"}
[releases page](https://github.com/restatedev/restate/releases), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap)

Check warning on line 121 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L121 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 121, "column": 71}}}, "severity": "WARNING"}
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate-server)
with `npm install @restatedev/restate-server`.
:::


</TabItem>
<TabItem value="mac" label="macOS">
Expand All @@ -138,6 +145,13 @@
are running behind this deployment and will keep track of these (including of the method signatures).
After executing this curl request, you should see the discovered services and methods printed to your terminal.

:::tip
Restate is a single self-contained binary and Docker just one of the ways to run it. You can also obtain the binary from the

Check notice on line 149 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L149 

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

Check warning on line 149 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L149 

[write-good.TooWordy] 'obtain' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'obtain' is too wordy.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 149, "column": 99}}}, "severity": "WARNING"}
[releases page](https://github.com/restatedev/restate/releases), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap)

Check warning on line 150 in docs/quickstart.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/quickstart.mdx#L150 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/quickstart.mdx", "range": {"start": {"line": 150, "column": 71}}}, "severity": "WARNING"}
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate-server)
with `npm install @restatedev/restate-server`.
:::

</TabItem>
</Tabs>

Expand Down
8 changes: 6 additions & 2 deletions docs/restate/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
---

# Deployment
Restate is currently a single binary that contains everything you need. You can obtain the binary from the

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

View workflow job for this annotation

GitHub Actions / vale

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

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

Check warning on line 7 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

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

[write-good.Weasel] 'currently' is a weasel word!
Raw output 
{"message": "[write-good.Weasel] 'currently' is a weasel word!", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 7, "column": 12}}}, "severity": "WARNING"}

Check warning on line 7 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

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

[write-good.TooWordy] 'obtain' is too wordy.
Raw output 
{"message": "[write-good.TooWordy] 'obtain' is too wordy.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 7, "column": 81}}}, "severity": "WARNING"}
[releases page](https://github.com/restatedev/restate/releases), as part of a
[Docker image](https://hub.docker.com/r/restatedev/restate), from our [Homebrew tap](https://github.com/restatedev/homebrew-tap)

Check warning on line 9 in docs/restate/deployment.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/restate/deployment.md", "range": {"start": {"line": 9, "column": 67}}}, "severity": "WARNING"}
with `brew install restatedev/tap/restate`, or from [npm](https://www.npmjs.com/package/@restatedev/restate)
with `npm install @restatedev/restate-server`.

Restate is currently a single binary that contains everything you need.
It exposes three services by default, each on different ports:
The binary exposes three services by default, each on different ports:

| Name | Port | Description | Protocol |
|----------|------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
Expand Down