-
Notifications
You must be signed in to change notification settings - Fork 2k
chore(docs): convert 'Turbo' into 'Turborepo' #10162
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
Changes from all commits
73bc2ea
b7374c4
71084c4
c039158
967d5a2
9d5ee27
b7320ab
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,37 @@ | ||
--- | ||
title: Governance | ||
description: Turbo by Vercel is the next-generation build system for the web. | ||
description: Turborepo by Vercel is the next-generation build system for the web. | ||
--- | ||
|
||
- Turborepo was created by the team at [Vercel](https://vercel.com) in 2020. | ||
- Turbopack was created by the team at [Vercel](https://vercel.com) in 2022. | ||
|
||
The research and development of Turbo is led by the core team working full-time at Vercel. Turbo is a collaborative open-source effort to build tools for web developers. | ||
The research and development of Turborepo is led by the core team working full-time at Vercel. Turborepo is a collaborative open-source effort to build tools for web developers. | ||
|
||
## Teams | ||
|
||
**Core Team**: Turborepo and Turbopack teams at [Vercel](https://vercel.com) manage the direction of Turbo and leadership of the project. | ||
**Core Team**: Turborepo and Turbopack teams at [Vercel](https://vercel.com) manage the direction of Turborepo and leadership of the project. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to drop Turbopack mention? |
||
|
||
**Documentation**: DevRel teams at [Vercel](https://vercel.com) manage documentation and learning platforms. | ||
|
||
## Roadmap and RFC Process | ||
|
||
Large architecture decisions and features start as a [Request for Comments (RFC)](https://github.com/vercel/turbo/discussions/categories/rfc) inside GitHub Discussions. The entire Turbo community is invited to be involved in the process and discuss the tradeoffs of proposed work. | ||
Large architecture decisions and features start as a [Request for Comments (RFC)](https://github.com/vercel/turborepo/discussions/categories/rfc) inside GitHub Discussions. The entire Turborepo community is invited to be involved in the process and discuss the tradeoffs of proposed work. | ||
|
||
This process is essential to ensure features are built together with the community and our collaborators. More minor changes including bug fixes and documentation improvements are still implemented through GitHub pull requests. However, for larger initiatives, we believe it's essential to follow the RFC process. | ||
|
||
## Stability and release phases | ||
|
||
- **Experimental**: Experimental features lack essential capabilities required to be ready for stability. The feature is considered to be under active development and is being built to transition into Beta. | ||
- **Beta**: Beta means the feature does not yet meet our quality standards for a stable release. There is also usually a need for more information or feedback from Turbo developers to validate this feature works as expected in a variety of environments. | ||
- **Beta**: Beta means the feature does not yet meet our quality standards for a stable release. There is also usually a need for more information or feedback from Turborepo developers to validate this feature works as expected in a variety of environments. | ||
- **Stable**: When the features reach stability, it is considered ready for use in production. APIs marked as stable will only change in a backward-compatible way unless there is a major release. | ||
- **Deprecated**: A feature is in the process of being removed. Deprecated features include documentation for existing users with the next steps and information on when to expect the feature to be removed. | ||
|
||
## Turbo Support | ||
## Turborepo Support | ||
|
||
For individual developers looking for free support on their Turbo repositories, they can ask questions in [GitHub Discussions](https://github.com/vercel/turbo/discussions) or in [Vercel Community's `#turborepo` tag](https://vercel.community/tag/turborepo). | ||
For individual developers looking for free support on their Turborepo repositories, they can ask questions in [GitHub Discussions](https://github.com/vercel/turborepo/discussions) or in [Vercel Community's `#turborepo` tag](https://vercel.community/tag/turborepo). | ||
|
||
For companies looking for paid support on their Turbo repositories, they can [contact the Turbo team at Vercel](https://vercel.com/contact) for more information. | ||
For companies looking for paid support on their Turborepo repositories, they can [contact the Turborepo team at Vercel](https://vercel.com/contact) for more information. | ||
|
||
## Additional Resources | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
export const PRODUCT_SLOGANS = { | ||
turbo: | ||
"Turbo is an incremental bundler and build system optimized for JavaScript and TypeScript, written in Rust.", | ||
"Turborepo is a build system optimized for JavaScript and TypeScript, written in Rust.", | ||
repo: "The build system that makes ship happen.", | ||
Comment on lines
2
to
4
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we still use both of these slogans in different places? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see only one other reference to "bundler" and its a keeper until I redesign the home page. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, or did you mean more generally? We use both of these here and there but do need to audit/rework/pick one in time, yes. |
||
} as const; | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,9 +46,7 @@ export const createMetadata = ({ | |
title, | ||
description, | ||
canonicalPath, | ||
product, | ||
}: { | ||
product?: Products; | ||
title?: string; | ||
description?: string; | ||
/** You do not need to supply the domain! `metadataBase` already does that for you. */ | ||
|
@@ -59,30 +57,15 @@ export const createMetadata = ({ | |
console.warn(`Warning: ${canonicalPath} does not have a description.`); | ||
} | ||
|
||
const formatTitle = (): string => { | ||
if (canonicalPath === "/repo") { | ||
return "Turborepo"; | ||
} | ||
|
||
if (product === "repo") { | ||
return `${title} | Turborepo`; | ||
} | ||
Comment on lines
-67
to
-69
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe worth keeping the | Turborepo in the title for tabs so you can quickly find your Turborepo docs There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oops, good catch. |
||
|
||
return title ?? "Turbo"; | ||
}; | ||
|
||
const formattedTitle = formatTitle(); | ||
|
||
return { | ||
metadataBase: getBaseURL(), | ||
title: formattedTitle, | ||
title: title ? `${title} | Turborepo` : "Turborepo", | ||
description, | ||
openGraph: { | ||
siteName: "Turbo", | ||
siteName: "Turborepo", | ||
images: [ | ||
createOgImagePath({ | ||
title: canonicalPath === "/" ? "" : title, | ||
product, | ||
canonicalPath, | ||
}), | ||
], | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this just unused?