Skip to content

Commit

Permalink
docs: update links to logs in turbo types (#8403)
Browse files Browse the repository at this point in the history
### Description

<!--
  ✍️ Write a short summary of your work.
  If necessary, include relevant screenshots.
-->

I noticed that quite a few of the links in the JSON schema's reference
are outdated. I have only updated links to fields that still exist, not
removed `dotEnv` and `globalDotEnv`.

Some of the links are changed only in capitalization, this is because
Edge (the only browser I tested in) did not recognize the anchors if the
capitalization was not identical to the anchors.

After updating the JSDocs, I generated a new version of the JSON schema
in `docs/public`. Please verify that this is now correct.

---------

Co-authored-by: Sindre Haugland Bøyum <[email protected]>
Co-authored-by: Anthony Shew <[email protected]>
  • Loading branch information
3 people authored Jun 10, 2024
1 parent d25224b commit 205d9ee
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions packages/turbo-types/src/types/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface BaseSchema {
* these conventions to schedule, execute, and cache the outputs of tasks in
* your project.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#pipeline
* Documentation: https://turbo.build/repo/docs/reference/configuration#tasks
*
* @defaultValue `{}`
*/
Expand Down Expand Up @@ -94,7 +94,7 @@ export interface RootSchema extends BaseSchema {
* An allowlist of environment variables that should be made to all tasks, but
* should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalPassThroughEnv
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
*
* @defaultValue null
* @deprecated use `globalPassThroughEnv` instead
Expand All @@ -105,7 +105,7 @@ export interface RootSchema extends BaseSchema {
* An allowlist of environment variables that should be made to all tasks, but
* should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalPassThroughEnv
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
*
* @defaultValue null
*/
Expand Down Expand Up @@ -133,7 +133,7 @@ export interface RootSchema extends BaseSchema {
/**
* Enable use of the UI for `turbo`.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#experimentalui
* Documentation: https://turbo.build/repo/docs/reference/configuration#ui
*
* @defaultValue `"tui"`
*/
Expand Down Expand Up @@ -182,7 +182,7 @@ export interface Pipeline {
* task's environment, but should not contribute to the task's cache key,
* e.g. `AWS_SECRET_KEY`.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#passThroughEnv
* Documentation: https://turbo.build/repo/docs/reference/configuration#passthroughenv
*
* @defaultValue null
* @deprecated use `passThroughEnv` instead
Expand All @@ -194,7 +194,7 @@ export interface Pipeline {
* task's environment, but should not contribute to the task's cache key,
* e.g. `AWS_SECRET_KEY`.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#passThroughEnv
* Documentation: https://turbo.build/repo/docs/reference/configuration#passthroughenv
*
* @defaultValue null
*/
Expand Down Expand Up @@ -264,7 +264,7 @@ export interface Pipeline {
*
* "none": Hides all task output
*
* Documentation: https://turbo.build/repo/docs/reference/command-line-reference#--output-logs
* Documentation: https://turbo.build/repo/docs/reference/run#--output-logs-option
*
* @defaultValue full
*/
Expand Down

0 comments on commit 205d9ee

Please sign in to comment.