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

chore(docs): fix broken links #2373

Merged
merged 2 commits into from
Oct 26, 2022
Merged

chore(docs): fix broken links #2373

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
9aa478f
chore(docs): fix broken links
ChFlick Oct 26, 2022
43a0e6c
Merge branch 'main' into main
jaredpalmer Oct 26, 2022
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/repo/docs/core-concepts/monorepos/running-tasks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ This explicit configuration for `frontend#deploy` may seem to conflict with the

1. Although this `<workspace>#<task>` syntax is a useful escape hatch, we generally recommend using it for deployment orchestration tasks such as health checks, rather than build-time dependencies, so that Turborepo can optimize these tasks more efficiently
1. Package-tasks do not inherit cache configuration. You must redeclare
[`outputs`](../reference/configuration#outputs) at the moment.
[`outputs`](../../reference/configuration#outputs) at the moment.
1. `<workspace>` must match the `name` key in the workspace's `package.json` or the task will be ignored.

</Callout>
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/repo/docs/getting-started/existing-monorepo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { Tabs, Tab } from "../../../../components/Tabs";

## Configure workspaces

`turbo` is built on top of Workspaces, a way of managing multiple packages from within a single monorepo package. Turborepo is compatible with the workspace implementations from all package managers. For more information on managing your Turborepo workspaces, see the [Workspaces](../guides/workspaces) documentation.
`turbo` is built on top of Workspaces, a way of managing multiple packages from within a single monorepo package. Turborepo is compatible with the workspace implementations from all package managers. For more information on managing your Turborepo workspaces, see the [Workspaces](../handbook/workspaces) documentation.

You can configure workspaces any way you want, but a common folder structure example is keeping applications in the `/apps` folder and packages in the `/packages` folder. The configuration of these folders is different for each package manager.

Expand Down Expand Up @@ -93,9 +93,9 @@ In the root of your monorepo, create an empty file named `turbo.json`. This will

## Create a `pipeline`

To define your monorepo's task dependency graph, use the [`pipeline`](../core-concepts/pipelines) key in the `turbo.json` configuration file at the root of monorepo. `turbo` interprets this configuration to optimally schedule, execute, and cache the outputs of each of the `package.json` scripts defined in your workspaces.
To define your monorepo's task dependency graph, use the [`pipeline`](../core-concepts/monorepos/running-tasks) key in the `turbo.json` configuration file at the root of monorepo. `turbo` interprets this configuration to optimally schedule, execute, and cache the outputs of each of the `package.json` scripts defined in your workspaces.

Each key in the [`pipeline`](../core-concepts/pipelines) object is the name of a `package.json` script that can be executed by [`turbo run`](../reference/command-line-reference#turbo-run-task). You can specify its dependencies with the [`dependsOn`](../reference/configuration#dependson) key inside it as well as some other options related to [caching](../core-concepts/caching). For more information on configuring your pipeline, see the [`Pipelines`](../core-concepts/pipelines) documentation.
Each key in the [`pipeline`](../core-concepts/monorepos/running-tasks) object is the name of a `package.json` script that can be executed by [`turbo run`](../reference/command-line-reference#turbo-run-task). You can specify its dependencies with the [`dependsOn`](../reference/configuration#dependson) key inside it as well as some other options related to [caching](../core-concepts/caching). For more information on configuring your pipeline, see the [`Pipelines`](../core-concepts/monorepos/running-tasks) documentation.

Workspaces that do not have the specified script defined in their `package.json`'s list of `scripts` will be ignored by `turbo`.

Expand Down Expand Up @@ -251,6 +251,6 @@ You're now up and running with Turborepo, but there are still a few things to do

- [Understand how Turborepo caching works](../core-concepts/caching)
- [Correctly handle environment variables](../core-concepts/caching#alter-caching-based-on-environment-variables-and-files)
- [Learn to orchestrate task running with pipelines](../core-concepts/pipelines)
- [Learn to orchestrate task running with pipelines](../core-concepts/monorepos/running-tasks)
- [Efficiently filter package tasks](../core-concepts/filtering)
- [Configure Turborepo with your CI provider](../ci)
8 changes: 4 additions & 4 deletions docs/pages/repo/docs/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ This guide aims to help you debug issues with your Turborepo builds and configur

- Is any source code being generated during the build that isn't checked into git?
- This would change the fingerprint Turborepo uses to store build outputs.
- Are [cache outputs correctly specified](./core-concepts/caching#configuring-cache-outputs) in your Turborepo [pipeline](./core-concepts/pipelines#defining-a-pipeline)?
- Pipeline settings are not inherited or merged, so they need to be re-specified in [workspace-specific tasks](./core-concepts/pipelines#implicit-dependencies-and-specific-package-tasks) (e.g. `web#build` does **not** inherit pipeline settings from `build`).
- Are [cache outputs correctly specified](./core-concepts/caching#configuring-cache-outputs) in your Turborepo [pipeline](./core-concepts/monorepos/running-tasks#defining-a-pipeline)?
- Pipeline settings are not inherited or merged, so they need to be re-specified in [workspace-specific tasks](./core-concepts/monorepos/running-tasks#specific-workspace-tasks) (e.g. `web#build` does **not** inherit pipeline settings from `build`).
- [Are relevant inlined environment variables accounted for?](./core-concepts/caching#alter-caching-based-on-environment-variables-and-files)
- To verify, run `turbo` in verbose mode by adding `-vvv` to `turbo run <task>` and look at which environment variables are included in the hashes.

## I'm seeing cache hits, but my build is broken

- Are [cache outputs properly specified](./core-concepts/caching#configuring-cache-outputs) in your Turborepo [pipeline](./core-concepts/pipelines#defining-a-pipeline)?
- Pipeline settings are not inherited or merged, so they need to be re-specified in [workspace-specific tasks](./core-concepts/pipelines#implicit-dependencies-and-specific-package-tasks) (e.g. `web#build` does **not** inherit pipeline settings from `build`).
- Are [cache outputs properly specified](./core-concepts/caching#configuring-cache-outputs) in your Turborepo [pipeline](./core-concepts/monorepos/running-tasks#defining-a-pipeline)?
- Pipeline settings are not inherited or merged, so they need to be re-specified in [workspace-specific tasks](./core-concepts/monorepos/running-tasks#specific-workspace-tasks) (e.g. `web#build` does **not** inherit pipeline settings from `build`).

## My build is caching the wrong environment variables

Expand Down