-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Re-jigged the landing and getting started pages #1901
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
mattpocock
merged 12 commits into
main
from
matt/re-jigged-the-landing-and-getting-started-pages
Sep 13, 2022
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
fdf36fe
Re-jigged the landing and getting started pages
mattpocock 099ad59
Added Learn More area
mattpocock 43fc904
Rephrased some things on the home page
mattpocock d398a89
Improved features boxes
mattpocock bf11e8e
Added pink gradient
mattpocock 55a579e
Fixed weird height of _app level svg
mattpocock dc9d249
Removed dead icon
mattpocock dd4373c
Update docs/pages/docs/core-concepts/why-turborepo.mdx
mattpocock c15bbac
Update docs/components/QuickStart.tsx
mattpocock d5b9dfe
Merge branch 'main' into matt/re-jigged-the-landing-and-getting-start…
mattpocock 5f1100b
Merge branch 'main' into matt/re-jigged-the-landing-and-getting-start…
mattpocock 1d053f2
Merge branch 'main' into matt/re-jigged-the-landing-and-getting-start…
mattpocock File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Why Turborepo? | ||
|
|
||
| ## The problem | ||
|
|
||
| Monorepos have many advantages - but **they struggle to scale**. Each workspace has its own test suite, its own linting and its own build process. A single monorepo might have **hundreds of tasks to execute**. | ||
|
|
||
| ## The solution | ||
|
|
||
| **Turborepo solves your monorepo's scaling problem**. Our remote cache stores the result of all your tasks, meaning that **your CI never needs to do the same work twice**. | ||
|
|
||
| Task scheduling can be difficult in a monorepo. Imagine `yarn build` needs to run before `yarn test`, across all your workspaces. Turborepo **can schedule your tasks for maximum speed**, across all available cores. | ||
|
|
||
| Turborepo can be **adopted incrementally**. It uses the `package.json` scripts you've already written, the dependencies you've already declared, and a single `turbo.json` file. You can **use it with any package manager**, like `npm`, `yarn` or `pnpm`. You can add it to any monorepo in just a few minutes. | ||
|
|
||
| ## What turborepo is not | ||
|
|
||
| Turborepo **doesn't handle package installation**. Tools like `npm`, `pnpm` or `yarn` already do that brilliantly. But they run tasks inefficiently, meaning slow CI builds. | ||
|
|
||
| We recommend that **Turborepo runs your tasks**, and your favorite package manager installs your packages. |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,27 @@ | ||
| --- | ||
| title: Documentation | ||
| description: Turborepo is a high-performance build system for JavaScript and TypeScript codebases. | ||
| title: Turborepo Quickstart | ||
| description: Create your first monorepo or add Turborepo to an existing project. | ||
| --- | ||
|
|
||
| import { DocsFeatures } from "../../components/Features"; | ||
| import { QuickStartArea, LearnMoreArea } from "../../components/QuickStart"; | ||
| import { ExamplesArea } from "../../components/ExamplesArea"; | ||
|
|
||
| # Turborepo Documentation | ||
| # Turborepo Quickstart | ||
|
|
||
| <DocsFeatures detailed={false} /> | ||
| Turborepo is a smart **build system for JavaScript/TypeScript monorepos**: codebases containing multiple projects, often using multiple frameworks, in a single, unified code repository. | ||
|
|
||
| Turborepo is a blazing fast build system for JavaScript/TypeScript _monorepos_: codebases containing multiple | ||
| projects, often using multiple frameworks, in a single, unified | ||
| code repository. | ||
| Unlike other build systems, Turborepo is designed to be **incrementally adopted**, so you can add it to most codebases in a few minutes. | ||
|
|
||
| ## The problem | ||
|
|
||
| Monorepos have many advantages - but **they struggle to scale**. Each workspace you add has its own test suite, its own linting and its own build process. A single monorepo might have **hundreds of tasks to perform**. | ||
|
|
||
| ## The solution | ||
|
|
||
| **Turborepo solves your monorepo's scaling problem**. Our remote cache stores the result of all your tasks, meaning that **your CI never needs to do the same work twice**. | ||
|
|
||
| Task scheduling can be difficult in a monorepo. Imagine `yarn build` needs to run before `yarn test`, across all your workspaces. Turborepo **can schedule your tasks for maximum speed**, across all available cores. | ||
|
|
||
| Turborepo can be **adopted incrementally**. It uses the `package.json` scripts you've already written, the dependencies you've already declared, and a single `turbo.json` file. You can **use it with any package manager**, like `npm`, `yarn` or `pnpm`. You can add it to any monorepo in just a few minutes. | ||
| <QuickStartArea /> | ||
|
|
||
| ## Features | ||
|
|
||
| - **Never do the same work twice**: Turborepo will remember the output of tasks you (or your CI) ran and skip work that's already been done. | ||
| - **Optimized scheduling**: Execute tasks using every core at maximum parallelism without wasting idle CPUs. | ||
| - **Remote caching**: Share a remote cache across your organization for faster builds on CI/CD. | ||
| - **Zero runtime overhead**: Turborepo doesn't interfere with your runtime code or touch your sourcemaps. | ||
| Turborepo leverages advanced build system techniques to speed up development, **both on your local machine and your CI/CD**. | ||
|
|
||
| <LearnMoreArea /> | ||
|
|
||
| ## What turborepo is not | ||
| ## Examples | ||
|
|
||
| Turborepo **doesn't handle package installation**. Tools like `npm`, `pnpm` or `yarn` already do that brilliantly. But they run tasks inefficiently, meaning slow CI builds. | ||
| You can also clone a Turborepo starter repository to get a head start on your monorepo. For even more examples and starters, see the [Turborepo examples directory on GitHub](https://github.com/vercel/turborepo/tree/main/examples). | ||
|
|
||
| We recommend that **Turborepo runs your tasks**, and your favorite package manager installs your packages. | ||
| <ExamplesArea /> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.