Skip to content

Commit

Permalink
chore(repo): update readme and links (#8965)
Browse files Browse the repository at this point in the history
### Description

Update the README, and update repository links

### Testing Instructions

<!--
  Give a quick description of steps to test your changes.
-->
  • Loading branch information
tknickman committed Aug 8, 2024
1 parent 2af20ed commit 3ba1142
Show file tree
Hide file tree
Showing 64 changed files with 121 additions and 130 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/0-turborepo-bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ body:
- type: markdown
attributes:
value: |
This template is to report Turborepo bugs. Before opening a new issue, please do a [search](https://github.com/vercel/turbo/issues) of existing issues and :+1: upvote the existing issue instead. This will result in a quicker resolution.
This template is to report Turborepo bugs. Before opening a new issue, please do a [search](https://github.com/vercel/turborepo/issues) of existing issues and :+1: upvote the existing issue instead. This will result in a quicker resolution.
If you need help with your own project, you can:
- Start a discussion in the ["Help" section](https://github.com/vercel/turbo/discussions/categories/help).
- Start a discussion in the ["Help" section](https://github.com/vercel/turborepo/discussions/categories/help).
- Ask a question in [the Turbo Discord server](https://turbo.build/discord).
- type: checkboxes
Expand All @@ -23,7 +23,7 @@ body:
attributes:
label: Link to code that reproduces this issue
description: |
A link to a **public** GitHub repository with a minimal reproduction. Ideally, minimal reproductions should be created using [`npx create-turbo@canary -e with-shell-commands`](https://github.com/vercel/turbo/tree/main/examples/with-shell-commands) and should include only changes that contribute to the issue. You may also use [`npx create-turbo@canary -e <example-name>`](https://github.com/vercel/turbo/tree/main/examples) to create a reproduction that includes frameworks if you believe your bug requires a framework to reproduce.
A link to a **public** GitHub repository with a minimal reproduction. Ideally, minimal reproductions should be created using [`npx create-turbo@canary -e with-shell-commands`](https://github.com/vercel/turborepo/tree/main/examples/with-shell-commands) and should include only changes that contribute to the issue. You may also use [`npx create-turbo@canary -e <example-name>`](https://github.com/vercel/turborepo/tree/main/examples) to create a reproduction that includes frameworks if you believe your bug requires a framework to reproduce.
validations:
required: true

Expand Down Expand Up @@ -89,7 +89,7 @@ body:
- type: markdown
attributes:
value: |
Another way you can help the maintainers is to pinpoint the `canary` version of `turbo` that introduced the issue. Check out our [releases](https://github.com/vercel/turbo/releases), and try to find the first `canary` release that introduced the issue. This will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of `turbo` by running `npm install turbo@<version>`.
Another way you can help the maintainers is to pinpoint the `canary` version of `turbo` that introduced the issue. Check out our [releases](https://github.com/vercel/turborepo/releases), and try to find the first `canary` release that introduced the issue. This will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of `turbo` by running `npm install turbo@<version>`.
- type: textarea
attributes:
label: Additional context
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ contact_links:
url: https://github.com/vercel/next.js/issues/new?assignees=&labels=template%3A+bug&projects=&template=1.bug_report.yml
about: Create a Next.js bug report for the Turbopack team
- name: Ask for help
url: https://github.com/vercel/turbo/discussions/new?category=help
url: https://github.com/vercel/turborepo/discussions/new?category=help
about: Need to ask a question? Get help from the community.
- name: Submit an idea
url: https://github.com/vercel/turbo/discussions/new?category=ideas
url: https://github.com/vercel/turborepo/discussions/new?category=ideas
about: Make feature requests and suggest improvements.
31 changes: 11 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,38 @@
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4060187/196936123-f6e1db90-784d-4174-b774-92502b718836.png">
<img src="https://user-images.githubusercontent.com/4060187/196936104-5797972c-ab10-4834-bd61-0d1e5f442c9c.png" height="128">
</picture>
<h1 align="center">Turbo</h1>
<h1 align="center">Turborepo</h1>
</a>
</p>

<p align="center">
<a aria-label="Vercel logo" href="https://vercel.com/"><img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000"></a>
<a aria-label="NPM version" href="https://www.npmjs.com/package/turbo"><img alt="" src="https://img.shields.io/npm/v/turbo.svg?style=for-the-badge&labelColor=000000"></a>
<a aria-label="License" href="https://github.com/vercel/turbo/blob/main/LICENSE"><img alt="" src="https://img.shields.io/npm/l/turbo.svg?style=for-the-badge&labelColor=000000&color="></a>
<a aria-label="Join the community on GitHub" href="https://github.com/vercel/turbo/discussions"><img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=turborepo&labelColor=000000&logoWidth=20&logoColor=white"></a>
<a aria-label="License" href="https://github.com/vercel/turborepo/blob/main/LICENSE"><img alt="" src="https://img.shields.io/npm/l/turbo.svg?style=for-the-badge&labelColor=000000&color="></a>
<a aria-label="Join the community on GitHub" href="https://github.com/vercel/turborepo/discussions"><img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=turborepo&labelColor=000000&logoWidth=20&logoColor=white"></a>
</p>

Turbo is a next-generation toolchain for frontend development, written in Rust. It consists of 3 major parts:

- [**Turbopack:**](https://turbo.build/pack) an incremental bundler (the successor to Webpack)
- [**Turborepo:**](https://turbo.build/repo) an incremental build system
- The Turbo engine: a low-level incremental computation and memoization engine
Turborepo is a high-performance build system for JavaScript and TypeScript codebases, written in Rust.

## Getting Started

Visit https://turbo.build to get started with Turbopack and Turborepo.
Visit https://turbo.build/repo to get started with Turborepo.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## Community

The Turbo community can be found on [GitHub Discussions](https://github.com/vercel/turbo/discussions), where you can ask questions, voice ideas, and share your projects.
The Turborepo community can be found on [GitHub Discussions](https://github.com/vercel/turborepo/discussions), where you can ask questions, voice ideas, and share your projects.

To chat with other community members, you can join the [Turbo Discord](https://turbo.build/discord).
To chat with other community members, you can join the [Turborepo Discord](https://turbo.build/discord).

Our [Code of Conduct](https://github.com/vercel/turbo/blob/main/CODE_OF_CONDUCT.md) applies to all Turbo community channels.
Our [Code of Conduct](https://github.com/vercel/turborepo/blob/main/CODE_OF_CONDUCT.md) applies to all Turborepo community channels.

## Who is using Turbo?
## Who is using Turborepo?

Turbo is used by the world's leading companies. Check out the [Turbo Showcase](https://turbo.build/showcase) to learn more.
Turborepo is used by the world's leading companies. Check out the [Turborepo Showcase](https://turbo.build/showcase) to learn more.

## Updates

Expand All @@ -51,13 +47,8 @@ Follow [@turborepo](https://x.com/turborepo) on X and for project updates.

- Jared Palmer ([@jaredpalmer](https://x.com/jaredpalmer))

**Turbopack and the Turbo engine**

- Tobias Koppers ([@wSokra](https://x.com/wSokra))
- Maia Teegarden ([@padmaia](https://x.com/padmaia))

## Security

If you believe you have found a security vulnerability in Turbo, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email `[email protected]` to disclose any security vulnerabilities.
If you believe you have found a security vulnerability in Turborepo, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email `[email protected]` to disclose any security vulnerabilities.

https://vercel.com/security
2 changes: 1 addition & 1 deletion buildcontainer/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ include .env
REGISTRY ?= ghcr.io
TAG_VERSION ?= snapshot
OWNER ?= goreleaser
GIT_REPO ?= https://github.com/vercel/turbo
GIT_REPO ?= https://github.com/vercel/turborepo

ifeq ($(REGISTRY),)
IMAGE_BASE_NAME := $(OWNER)/goreleaser-cross-base:$(TAG_VERSION)
Expand Down
2 changes: 1 addition & 1 deletion cli/scripts/npm-native-packages/template/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `turbo`

This is a platform-specific binary for Turborepo, a monorepo build system. See https://github.com/vercel/turbo for details.
This is a platform-specific binary for Turborepo, a monorepo build system. See https://github.com/vercel/turborepo for details.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"name": "turbo-{{Os}}-{{Arch}}",
"version": "{{Version}",
"description": "The {{Os}}-{{Arch}} binary for turbo, a monorepo build system.",
"repository": "https://github.com/vercel/turbo",
"bugs": "https://github.com/vercel/turbo/issues",
"repository": "https://github.com/vercel/turborepo",
"bugs": "https://github.com/vercel/turborepo/issues",
"homepage": "https://turbo.build/repo",
"license": "MIT",
"os": ["{{Os}}"],
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/daemon/proto/turbod.proto
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
syntax = "proto3";

option go_package = "github.com/vercel/turbo/cli/internal/turbodprotocol";
option go_package = "github.com/vercel/turborepo/cli/internal/turbodprotocol";

package turbodprotocol;

Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/panic_handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use human_panic::report::{Method, Report};
use crate::get_version;

const OPEN_ISSUE_MESSAGE: &str =
"Please open an issue at https://github.com/vercel/turbo/issues/new/choose";
"Please open an issue at https://github.com/vercel/turborepo/issues/new/choose";

pub fn panic_handler(panic_info: &std::panic::PanicInfo) {
let cause = panic_info
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/shim/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ fn try_check_for_updates(args: &ShimArgs, current_version: &str) {
// check for updates
let _ = display_update_check(
"turbo",
"https://github.com/vercel/turbo",
"https://github.com/vercel/turborepo",
Some(&footer),
current_version,
// use default for timeout (800ms)
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/task_graph/visitor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ impl<'a> Visitor<'a> {
}));
}
false => {
// TODO(gsoltis): if/when we fix https://github.com/vercel/turbo/issues/937
// TODO(gsoltis): if/when we fix https://github.com/vercel/turborepo/issues/937
// the following block should never get hit. In the meantime, keep it after
// hashing so that downstream tasks can count on the hash existing
//
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-telemetry/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# turborepo-telemetry

**NOTE**:
This crate has been ported to the [turbo-telemetry](https://github.com/vercel/turbo/blob/main/crates/turborepo-telemetry) node package.
This crate has been ported to the [turbo-telemetry](https://github.com/vercel/turborepo/blob/main/crates/turborepo-telemetry) node package.
Any changes made here should also be made to that package as well.

## Overview
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-telemetry/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/// NOTE: There is a port of this crate that is used to instrument node
/// projects. Any changes made here should be reflected there as well.
///
/// https://github.com/vercel/turbo/blob/main/packages/turbo-telemetry/src/config.ts
/// https://github.com/vercel/turborepo/blob/main/packages/turbo-telemetry/src/config.ts
use std::env;

use chrono::{DateTime, Utc};
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Build Requirement

1. Install `protobuf` and `golang` (note: Go must be pinned to v1.20.x, see https://github.com/vercel/turbo/issues/5918 for details)
1. Install `protobuf` and `golang` (note: Go must be pinned to v1.20.x, see https://github.com/vercel/turborepo/issues/5918 for details)

- On macOS: `brew install protobuf protoc-gen-go protoc-gen-go-grpc [email protected]`
- On Windows: `choco install golang --version=1.20.7` and `choco install protoc make python3 mingw`
Expand Down
2 changes: 1 addition & 1 deletion docs/repo-docs/acknowledgments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Thank you to all these developers, build systems, and monorepo tool

Turborepo was originally created by [Jared Palmer](https://x.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, Turborepo has a dedicated full-time team working on it as well as a growing list of [open source contributors](https://github.com/vercel/turbo/graphs/contributors).
Today, Turborepo has a 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 and Prior Art

Expand Down
10 changes: 5 additions & 5 deletions docs/repo-docs/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@ With over 2 million weekly downloads, Turborepo has a large and active community

## Contributing

- [Documentation](https://github.com/vercel/turbo/tree/main/docs): Suggest improvements or even write new sections to help build understanding of how to use Turborepo.
- [Examples](https://github.com/vercel/turbo/tree/main/examples): Help developers integrate Turborepo with other tools and services by improving an example.
- [Code](https://github.com/vercel/turbo/blob/main/CONTRIBUTING.md): Learn more about the underlying architecture, contribute bug fixes, and suggest new features.
- [Documentation](https://github.com/vercel/turborepo/tree/main/docs): Suggest improvements or even write new sections to help build understanding of how to use Turborepo.
- [Examples](https://github.com/vercel/turborepo/tree/main/examples): Help developers integrate Turborepo with other tools and services by improving an example.
- [Code](https://github.com/vercel/turborepo/blob/main/CONTRIBUTING.md): Learn more about the underlying architecture, contribute bug fixes, and suggest new features.

## Discussions

If you have a question about Turborepo or want to help others, join the conversation:

- [GitHub Discussions](https://github.com/vercel/turbo/discussions)
- [GitHub Discussions](https://github.com/vercel/turborepo/discussions)
- [Discord](https://turbo.build/discord)

## Acknowledgements

Turborepo was originally created by [Jared Palmer](https://x.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, Turborepo has dedicated full-time team working on it as well as a growing list of [open source contributors](https://github.com/vercel/turbo/graphs/contributors).
Today, Turborepo 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

Expand Down
16 changes: 8 additions & 8 deletions docs/repo-docs/crafting-your-repository/upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,16 @@ Turborepo 2.0 requires that your Workspace define this field as a way to improve

Turborepo 2.0 includes behavioral and correctness improvements with behavior of `turbo run` commands. Listed below is the summary of changes, which may or may not have an affect on your codebase:

- Strict Mode for environment variables is now the default, moving from Loose Mode ([PR](https://github.com/vercel/turbo/pull/8182))
- Strict Mode for environment variables is now the default, moving from Loose Mode ([PR](https://github.com/vercel/turborepo/pull/8182))
- → If it appears that the scripts in your tasks are missing environment variables, you can opt back out of this behavior using [the `--env-mode` option](/repo/docs/reference/run#--env-mode-option) on a per-command basis to incrementally migrate. We encourage you to update [the `env` key](/repo/docs/reference/configuration#env) in your task to account for all of its environment variables so you can drop the `--env-mode` option as soon as possible.
- Workspace root directory is now an implicit dependency of all packages ([PR](https://github.com/vercel/turbo/pull/8202))
- Workspace root directory is now an implicit dependency of all packages ([PR](https://github.com/vercel/turborepo/pull/8202))
- → The repository should have as little code in the root as possible, since changes to the root can affect all tasks in your repository. Additionally, if you're using [Internal Packages]() in the Workspace root, changes to those dependencies will also cause cache misses for all tasks. In both cases, consider moving the code out of the root and [into a package](/repo/docs/crafting-your-repository/structuring-a-repository).
- `--ignore` removed in favor of `--filter` and graph correctness changes below ([PR](https://github.com/vercel/turbo/pull/8201))
- Removed `--scope` flag (deprecated since 1.2) ([PR](https://github.com/vercel/turbo/pull/7970))
- `engines` field in root `package.json` is now used in hashing ([PR](https://github.com/vercel/turbo/pull/8173))
- `--filter` no longer infers namespaces for package names ([PR](https://github.com/vercel/turbo/pull/8137))
- `--filter` now errors when no package names or directories are matched ([PR](https://github.com/vercel/turbo/pull/8142))
- `--only` restricts task dependencies instead of package dependencies ([PR](https://github.com/vercel/turbo/pull/8163))
- `--ignore` removed in favor of `--filter` and graph correctness changes below ([PR](https://github.com/vercel/turborepo/pull/8201))
- Removed `--scope` flag (deprecated since 1.2) ([PR](https://github.com/vercel/turborepo/pull/7970))
- `engines` field in root `package.json` is now used in hashing ([PR](https://github.com/vercel/turborepo/pull/8173))
- `--filter` no longer infers namespaces for package names ([PR](https://github.com/vercel/turborepo/pull/8137))
- `--filter` now errors when no package names or directories are matched ([PR](https://github.com/vercel/turborepo/pull/8142))
- `--only` restricts task dependencies instead of package dependencies ([PR](https://github.com/vercel/turborepo/pull/8163))

</Step>
</Steps>
2 changes: 1 addition & 1 deletion docs/repo-docs/getting-started/editor-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ Visit the [VSCode Extension Marketplace](https://marketplace.visualstudio.com/it
<Callout type="info" title="Not using Visual Studio Code?">
The language server can be used on any editors that support the [Language
Server Protocol](https://microsoft.github.io/language-server-protocol/). Log a
request in our [issue tracker](https://github.com/vercel/turbo/issues) to
request in our [issue tracker](https://github.com/vercel/turborepo/issues) to
express your interest.
</Callout>
2 changes: 1 addition & 1 deletion docs/repo-docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The starter repository will have:
- Two deployable applications
- Three shared libraries for use in the rest of the monorepo

For more details on the starter, [visit the README for the basic starter on GitHub](https://github.com/vercel/turbo/tree/main/examples/basic). You can also [use an example](/repo/docs/getting-started/installation#start-with-an-example) that more closely fits your tooling interests.
For more details on the starter, [visit the README for the basic starter on GitHub](https://github.com/vercel/turborepo/tree/main/examples/basic). You can also [use an example](/repo/docs/getting-started/installation#start-with-an-example) that more closely fits your tooling interests.

## Installing `turbo`

Expand Down
2 changes: 1 addition & 1 deletion docs/repo-docs/guides/frameworks/nuxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Callout } from '#/components/callout';

## Quickstart

To get started with Nuxt in a Turborepo quickly, use [the `with-vue-nuxt` example](https://github.com/vercel/turbo/tree/main/examples/with-vue-nuxt):
To get started with Nuxt in a Turborepo quickly, use [the `with-vue-nuxt` example](https://github.com/vercel/turborepo/tree/main/examples/with-vue-nuxt):

<PackageManagerTabs>
<Tab>
Expand Down
2 changes: 1 addition & 1 deletion docs/repo-docs/guides/frameworks/sveltekit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Callout } from '#/components/callout';

## Quickstart

To get started with SvelteKit in a Turborepo quickly, use [the `with-svelte` example](https://github.com/vercel/turbo/tree/main/examples/with-svelte):
To get started with SvelteKit in a Turborepo quickly, use [the `with-svelte` example](https://github.com/vercel/turborepo/tree/main/examples/with-svelte):

<PackageManagerTabs>
<Tab>
Expand Down
Loading

0 comments on commit 3ba1142

Please sign in to comment.