Skip to content

Commit

Permalink
fix typo and grammar errors (#764)
Browse files Browse the repository at this point in the history
* Update README.md

* Update task.md

* Update getting-started.md

* Apply suggestions from code review

---------

Co-authored-by: Helio Machado <[email protected]>
  • Loading branch information
VaibhavWakde52 and 0x2b3bfa0 authored Oct 31, 2023
1 parent 53cd393 commit a5b15b6
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Supported cloud vendors [include][auth]:

## Why TPI?

There are a several reasons to use TPI instead of other related solutions (custom scripts and/or cloud orchestrators):
There are several reasons to use TPI instead of other related solutions (custom scripts and/or cloud orchestrators):

1. **Reduced management overhead and infrastructure cost**:
TPI is a CLI tool, not a running service. It requires no additional orchestrating machine (control plane/head nodes) to schedule/recover/terminate instances. Instead, TPI runs (spot) instances via cloud-native scaling groups[^scalers], taking care of recovery and termination automatically on the cloud provider's side. This design reduces management overhead & infrastructure costs. You can close your laptop while cloud tasks are running -- auto-recovery happens even if you are offline.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ With spot/preemptible instances (`spot >= 0`), auto-recovery logic and persisten

-> **Note:** A large `workdir` may take a long time to upload.

~> **Warning:** To take full advantage of spot instance recovery, a `script` should start by cheching the disk for results (recovered from a previous interrupted run).
~> **Warning:** To take full advantage of spot instance recovery, a `script` should start by checking the disk for results (recovered from a previous interrupted run).

-> **Note:** The [`id`](https://registry.terraform.io/providers/iterative/iterative/latest/docs/resources/task#id) returned by `terraform apply` (i.e. `[id=tpi-···]`) can be used to locate the created cloud resources through the cloud's web console or command–line tool.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ resource "iterative_task" "example" {
```

The container name may include a path component, in this case the specified subdirectory will be used
to store task execution results. Otherwise, a subdirectory will be created with a name matchin the
to store task execution results. Otherwise, a subdirectory will be created with a name matching the
task's randomly generated id.

If the container name is suffixed with a forward slash, (`container-name/`), the root of the container
Expand Down

0 comments on commit a5b15b6

Please sign in to comment.