这是indexloc提供的服务,不要输入任何密码
Skip to content

Fix typos in docs #201

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/docs/features/caching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ By now, you're probably wondering how `turbo` decides what constitutes a cache h

First `turbo` constructs a hash of the current global state of the monorepo:

- The contents of any file that satifies the the glob patterns in [`globalDependencies`](../reference/configuration#globalDependencies-1)
- The contents of any file that satisfies the glob patterns in [`globalDependencies`](../reference/configuration#globalDependencies-1)

Then it adds on more factors relative to a given package's task:

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/features/pipelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Sometimes tasks declared in the `pipeline` are not present in all packages' `pac

### Implicit Dependencies and Specific Package Tasks

Sometimes you need to manually place a package-task dependency on another package-task. This can occur especially in repos that are just coming off of a `lerna` or `rush` repository where the tasks are traditionally run in separate phases. Sometimes assumptions are made for those repositories that are not expressable in the simple task `pipeline` configuration, as seen above.
Sometimes you need to manually place a package-task dependency on another package-task. This can occur especially in repos that are just coming off of a `lerna` or `rush` repository where the tasks are traditionally run in separate phases. Sometimes assumptions are made for those repositories that are not expressible in the simple task `pipeline` configuration, as seen above.
Additionally, you may need to express implicit dependencies or sequences between applications or microservices when using `turbo` in CI/CD.

For these cases, you can express these relationships in your `pipeline` configuration like this:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/features/scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Callout from "../../../components/callout";
Scoping task execution can speed up the process especially if there are distinct clusters of packages that are not related to each other within your repository. Turborepo has a `scope` option that allows the task running to proceed up to the packages found that matches the `scope` argument. It's useful to think of `scope` as an "entry point" into your monorepo's package/task graph. This is a string matcher based on the name of the packages (not the package path).

<Callout type="info">
It is important to note that depedendents and dependencies refer to the
It is important to note that dependents and dependencies refer to the
package and task.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Your pipeline both defines the way in which your NPM `package.json` scripts rela
}
```

In the above example, the `build` and `test` tasks are dependant on their packages `dependencies` and `devDependencies` being built first, this is denoted with the `^` prefix.
In the above example, the `build` and `test` tasks are dependent on their packages `dependencies` and `devDependencies` being built first, this is denoted with the `^` prefix.

For each script in each workspace's `package.json`, Turborepo will cache files outputted to `dist/**` and `build/**` folders by default if an override isn't added. Using the [`outputs`](./features/caching#configuring-cache-outputs-1) array allows you to override the default cache folders,
like in the example above, where the `.next/**` folder is selected to be the default cache folder for the `build` task. Turborepo will automatically record and cache logs to `.turbo/turbo-<script>.log` for you, so you don't ever need to specify that in the `outputs` array.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/guides/migrate-from-lerna.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Turborepo and Lerna have a lot a in common, but also some key differences.

## Tool Comparison

Lerna is a a monorepo task runner and NPM workspace implementation. Both Turborepo and Lerna can be used to run tasks across packages in parallel and also topologically (i.e. if A depends on B, run B before A).
Lerna is a monorepo task runner and NPM workspace implementation. Both Turborepo and Lerna can be used to run tasks across packages in parallel and also topologically (i.e. if A depends on B, run B before A).

### Caching

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/docs/reference/command-line-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ turbo run test --concurrency=1

Defaults to `false`. This flag tells `turbo` whether or not to continue with execution in the presence of an error (i.e. non-zero exit code from a task).
By default, specifying the `--parallel` flag will automatically set `--continue` to `true` unless explicitly set to `false`.
When `--continue` is `true`, `turbo` will exit with the highest exit code value encountered during exection.
When `--continue` is `true`, `turbo` will exit with the highest exit code value encountered during execution.

```sh
turbo run build --continue
Expand Down Expand Up @@ -228,7 +228,7 @@ A bearer token for remote caching. Useful for running in non-interactive shells
turbo run build --team=my-team --token=xxxxxxxxxxxxxxxxx
```

You can also set the value of the current token by setting an environment variable named `TURBO_TOKEN`. The flag will take precendence over the environment variable if both are present.
You can also set the value of the current token by setting an environment variable named `TURBO_TOKEN`. The flag will take precedence over the environment variable if both are present.

#### `--team`

Expand All @@ -239,7 +239,7 @@ turbo run build --team=my-team
turbo run build --team=my-team --token=xxxxxxxxxxxxxxxxx
```

You can also set the value of the current team by setting an environment variable named `TURBO_TEAM`. The flag will take precendence over the environment variable if both are present.
You can also set the value of the current team by setting an environment variable named `TURBO_TEAM`. The flag will take precedence over the environment variable if both are present.

## `turbo prune --scope=<target>`

Expand Down Expand Up @@ -290,7 +290,7 @@ Default to `false`. Passing this flag will alter the outputted folder with the p

With the `--docker` flag. The `prune` command will generate folder called `out` with the following inside of it:

- A folder `json` with the pruned workspace's package.jsons
- A folder `json` with the pruned workspace's `package.json`s
- A folder `full` with the pruned workspace's full source code, but only including the internal packages that are needed to build the target.
- A new pruned lockfile that only contains the pruned subset of the original root lockfile with the dependencies that are actually used by the packages in the pruned workspace.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Defaults to `yarn`. The NPM client in-use in your project.

An object representing the task dependency graph of your project. `turbo` interprets these conventions to properly schedule, execute, and cache the outputs of tasks in your project.

Each key in the `pipeline` object is the name of a task that can be executed by `turbo run`. If `turbo` finds a workspace package with a `package.json` `scripts` object with a matching key, it will apply the pipline task configuration to that NPM script during execution. This allows you to use `pipeline` to set conventions across your entire Turborepo.
Each key in the `pipeline` object is the name of a task that can be executed by `turbo run`. If `turbo` finds a workspace package with a `package.json` `scripts` object with a matching key, it will apply the pipeline task configuration to that NPM script during execution. This allows you to use `pipeline` to set conventions across your entire Turborepo.

```json
{
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/docs/upgrading-to-v1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Follow the prompts and select the Vercel account (user or team) to wish to conne

### On Vercel

- If you already used Turborepo and Vercel together, you should remove `TURBO_TOKEN`, `TURBO_TEAM`, and `TURBO_PROJECT` enviroment variables from all projects. These are now automatically set on your behalf by Vercel.
- If you already used Turborepo and Vercel together, you should remove `TURBO_TOKEN`, `TURBO_TEAM`, and `TURBO_PROJECT` environment variables from all projects. These are now automatically set on your behalf by Vercel.

- Remove the usage of `--team`, `--token`, and `--project` CLI flags in your Vercel project settings and/or `package.json` scripts.

Expand All @@ -74,4 +74,4 @@ Follow the prompts and select the Vercel account (user or team) to wish to conne

### Getting Help

If you are having difficulty upgrading please file an issue on [GitHub](https://github.com/vercel/turborepo). If you are having difficulty with your remote caching on Vercel, please reach out in [Disord](https://turborepo.org/discord).
If you are having difficulty upgrading please file an issue on [GitHub](https://github.com/vercel/turborepo). If you are having difficulty with your remote caching on Vercel, please reach out in [Discord](https://turborepo.org/discord).