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

Add acknowledgements and callouts to docs #373

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 4 commits into from
Dec 20, 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
43 changes: 43 additions & 0 deletions docs/pages/docs/acknowledgments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Acknowledgements and Prior Art
---

# Acknowledgements

Turborepo was originally created by [Jared Palmer](https://twitter.com/jaredpalmer) as a closed-source enterprise software offering. In late 2021, [Vercel acquired Turborepo](https://vercel.com/blog/vercel-acquires-turborepo) and open sourced the codebase.

Today, Turbrepo has dedicated full-time team working on it as well as a growing list of [open source contributors](https://github.com/vercel/turborepo/graphs/contributors).

## Inspiration / Prior Art

At [Vercel](https://vercel.com), we believe deeply in the open source movement and in the power of open collaboration. To that end, it's important to provide meaningful attribution to the projects and people that inspire(d) us and our work.

We'd like to make a special shoutout to other build systems, monroepo tools, and prior art:

- Bazel - https://bazel.build
- Buck - https://buck.build
- Please - https://please.build
- Pants - https://www.pantsbuild.org
- Scoot - https://github.com/twitter/scoot
- TSDX - https://tsdx.io
- Lerna - https://lerna.js.org
- Lage - https://microsoft.github.io/lage
- Backfill - https://github.com/microsoft/backfill
- Bolt - https://github.com/boltpkg/bolt
- Preconstruct - https://preconstruct.tools
- Nx - https://nx.dev
- Yarn - https://yarnpkg.com
- NPM - https://www.npmjs.com
- PNPM - https://pnpm.js.org

Throughout the documentation, wherever applicable, we also provide inline callouts and links to the projects and people that have inspired us.

## Additional Thanks

Additionally, we're grateful to:

- [Rick Button](https://twitter.com/rickbutton) for donating the `turbo` package name on NPM
- [Iheanyi Ekechukwu](https://twitter.com/kwuchu) for helping Jared pick up Golang during the Pandemic!
- [Kenneth Chau](https://twitter.com/kennethchau) for Lage's Scope and Pipeline API and docs
- [Miguel Oller](https://mobile.twitter.com/ollermi) and [MakeSwift.com](https://makeswift.com) for piloting Turbo
- [Eric Kaslow](https://twitter.com/ekosz1), [Jack Hanford](https://twitter.com/jackhanford), and [Lattice.com](https://lattice.com) for piloting Turbo
12 changes: 7 additions & 5 deletions docs/pages/docs/features/pipelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ title: Pipelines
---

import Callout from "../../../components/callout";

<Callout>
This page and Turborepo's Pipeline API design was copied from the Microsoft Lage [Pipelines Page](https://microsoft.github.io/lage/guide/pipeline.html#defining-a-pipeline).
</Callout>
import HeartIcon from "@heroicons/react/solid/HeartIcon";

# Pipelining Package Tasks

Expand Down Expand Up @@ -63,7 +60,7 @@ The full pipeline can then be run:
npx turbo run build test lint deploy
```

Turborepo will then efficiently schedule execution minimizing idle CPUs.
Turborepo will then efficiently schedule execution minimizing idle CPUs.

## Task Dependency Format

Expand Down Expand Up @@ -182,3 +179,8 @@ This seems like it goes against the `"test": { "dependsOn": ["build"] }` and `"d
**Note: Package-tasks do not inherit cache configuration. You must redeclare
[`outputs`](../reference/configuration#outputs) at the moment.**
</Callout>

<Callout type="idea" icon={<HeartIcon className="h-5 w-5 mt-1 text-gray-400" aria-hidden="true" />}>
Turborepo's Pipeline API design and this page of documentation was inspired by [Microsoft's Lage project](https://microsoft.github.io/lage/guide/pipeline.html#defining-a-pipeline).
Shoutout to [Kenneth Chau](https://twitter.com/kenneth_chau) for the idea of fanning out tasks in such a concise and elegant way.
</Callout>
12 changes: 8 additions & 4 deletions docs/pages/docs/features/scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ title: Scoped tasks
---

import Callout from "../../../components/callout";

<Callout>
This page and Turborepo's Scoped Tasks API design was copied from the Microsoft Lage [Scoped Builds Page](https://microsoft.github.io/lage/guide/scopes.html#scoped-builds-with-all-its-dependents).
</Callout>
import HeartIcon from "@heroicons/react/solid/HeartIcon";

# Scoped Tasks

Expand Down Expand Up @@ -37,3 +34,10 @@ Sometimes we want to run the tasks needed to satisfy the `build` script of all t
```sh
turbo run build --scope=*build-tools* --no-deps --includeDependencies
```

<Callout type="idea" icon={<HeartIcon className="h-5 w-5 text-gray-400" aria-hidden="true" />}>
Turborepo's Scoped Tasks API design and docs were/are inspired [Microsoft's Lage project](https://microsoft.github.io/lage/guide/scopes.html#scoped-builds-with-all-its-dependents) `--scope` flag which was inspired by [Lerna's](https://github.com/lerna/lerna/tree/main/commands/run#readme).

We are working toward a new, more expressive task filtering/scoping syntax. [Read the RFC here.](https://github.com/vercel/turborepo/discussions/105)

</Callout>
1 change: 1 addition & 0 deletions docs/pages/docs/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"changelog": "Changelog",
"upgrading-to-v1": "Upgrading to v1",
"glossary": "Glossary",
"acknowledgements": "Acknowledgements",
"faq": "FAQ"
}