这是indexloc提供的服务,不要输入任何密码
Skip to content
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ Key characteristics of a great example include:
- One technology added to the `basic` example
- An updated README at the root of the example directory. Make sure to include any steps required to run the example
- All tasks in `turbo.json` in the example run successfully without any code changes needed
- Works with every package manager listed in our [Support Policy](https://turbo.build/repo/docs/getting-started/support-policy#package-managers)
- Works with every package manager listed in our [Support Policy](https://turbo.build/docs/getting-started/support-policy#package-managers)

Once you've created your example (with prior approval, as discussed above), you can submit a pull request to the repository.

Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-env/src/platform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ impl PlatformEnv {
let docs_message = color!(
color_config,
UNDERLINE,
"https://turbo.build/repo/docs/platform-environment-variables"
"https://turbo.build/docs/platform-environment-variables"
);

match ci {
Expand Down
4 changes: 2 additions & 2 deletions crates/turborepo-lib/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ pub enum Command {
/// Use the given selector to specify package(s) to act as
/// entry points. The syntax mirrors pnpm's syntax, and
/// additional documentation and examples can be found in
/// turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
/// turbo's documentation https://turbo.build/docs/reference/command-line-reference/run#--filter
#[clap(short = 'F', long, group = "scope-filter-group")]
filter: Vec<String>,
/// Get insight into a specific package, such as
Expand Down Expand Up @@ -895,7 +895,7 @@ pub struct ExecutionArgs {
/// Use the given selector to specify package(s) to act as
/// entry points. The syntax mirrors pnpm's syntax, and
/// additional documentation and examples can be found in
/// turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
/// turbo's documentation https://turbo.build/docs/reference/command-line-reference/run#--filter
#[clap(short = 'F', long, group = "scope-filter-group")]
pub filter: Vec<String>,

Expand Down
3 changes: 1 addition & 2 deletions crates/turborepo-lib/src/commands/link.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ pub(crate) enum SelectedTeam<'a> {
pub(crate) const REMOTE_CACHING_INFO: &str =
"Remote Caching makes your caching multiplayer,\nsharing build outputs and logs between \
developers and CI/CD systems.\n\nBuild and deploy faster.";
pub(crate) const REMOTE_CACHING_URL: &str =
"https://turbo.build/repo/docs/core-concepts/remote-caching";
pub(crate) const REMOTE_CACHING_URL: &str = "https://turbo.build/docs/core-concepts/remote-caching";

/// Verifies that caching status for a team is enabled, or prompts the user to
/// enable it.
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-lib/src/commands/telemetry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ fn log_status(config: TelemetryConfig, base: &CommandBase) {
);
}
}
println!("Learn more: https://turbo.build/repo/docs/telemetry");
println!("Learn more: https://turbo.build/docs/telemetry");
}

fn log_error(message: &str, error: &str, base: &CommandBase) {
Expand Down
4 changes: 2 additions & 2 deletions crates/turborepo-lib/src/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ pub enum Error {
#[error(transparent)]
PackageJson(#[from] turborepo_repository::package_json::Error),
#[error(
"Could not find turbo.json or turbo.jsonc.\nFollow directions at https://turbo.build/repo/docs to create \
one."
"Could not find turbo.json or turbo.jsonc.\nFollow directions at https://turbo.build/docs \
to create one."
)]
NoTurboJSON,
#[error(
Expand Down
4 changes: 2 additions & 2 deletions crates/turborepo-lib/src/diagnostics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ impl Diagnostic for GitDaemonDiagnostic {
if fsmonitor.trim() != "true" || untrackedcache.trim() != "true" {
chan.log_line("Git FS Monitor not configured".to_string())
.await;
chan.log_line( "For more information, see https://turbo.build/repo/docs/reference/command-line-reference/scan#fs-monitor".to_string()).await;
chan.log_line( "For more information, see https://turbo.build/docs/reference/command-line-reference/scan#fs-monitor".to_string()).await;
let Some(resp) = chan
.request(
"Configure it for this repo now?".to_string(),
Expand Down Expand Up @@ -372,7 +372,7 @@ impl Diagnostic for LSPDiagnostic {
Ok(None) => {
chan.log_line("Unable to find LSP instance".to_string())
.await;
chan.log_line( "For more information, see https://turbo.build/repo/docs/reference/command-line-reference/scan#lsp".to_string()).await;
chan.log_line( "For more information, see https://turbo.build/docs/reference/command-line-reference/scan#lsp".to_string()).await;
chan.failed("Turborepo Extension is not running".to_string())
.await;
}
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-telemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Any changes made here should also be made to that package as well.
## Overview

This crate provides a way to optionally record anonymous usage data.
This information is used to shape the Turborepo roadmap and prioritize features. You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the [documentation](https://turbo.build/repo/docs/telemetry):
This information is used to shape the Turborepo roadmap and prioritize features. You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the [documentation](https://turbo.build/docs/telemetry):

## Events

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 @@ -167,7 +167,7 @@ impl TelemetryConfig {
color_config,
GREY,
"{}",
"https://turbo.build/repo/docs/telemetry"
"https://turbo.build/docs/telemetry"
)
),
);
Expand Down
2 changes: 1 addition & 1 deletion crates/turborepo-telemetry/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Turborepo's telemetry library. Handles sending anonymous telemetry events to
//! the Vercel API in the background.
//!
//! More detail is available at https://turbo.build/repo/docs/telemetry.
//! More detail is available at https://turbo.build/docs/telemetry.

#![feature(error_generic_member_access)]

Expand Down
2 changes: 1 addition & 1 deletion docs/link-checker/src/markdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ const markdownProcessor = unified()
});

const filePathToUrl = (filePath: string): string =>
filePath.replace("repo-docs", "/repo/docs").replace(".mdx", "");
filePath.replace("repo-docs", "/docs").replace(".mdx", "");

const validateFrontmatter = (path: string, data: Record<string, unknown>) => {
if (!data.title) {
Expand Down
2 changes: 1 addition & 1 deletion docs/site/app/(openapi)/repo/source.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { loader } from "fumadocs-core/source";
import { openapiDocs, openapiMeta } from "@/.source";

export const openapiPages = loader({
baseUrl: "/repo/docs/openapi",
baseUrl: "/docs/openapi",
source: createMDXSource(openapiDocs, openapiMeta),
pageTree: {
attachFile,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export function SystemEnvironmentVariablesHashHighlighter(): JSX.Element {

useEffect(() => {
const hash = window.location.hash.substring(1);
if (path === "/repo/docs/reference/system-environment-variables" && hash) {
if (path === "/docs/reference/system-environment-variables" && hash) {
const element = document.getElementById(hash);
if (!element) return;
element.classList.add("focus");
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { NotFoundTemplate } from "../../_components/not-found-template";
import { NotFoundTemplate } from "../_components/not-found-template";

export default function NotFound(): JSX.Element {
return <NotFoundTemplate />;
Expand Down
74 changes: 37 additions & 37 deletions docs/site/app/(sidebar)/redirects-handler.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,125 +6,125 @@ import { useEffect } from "react";
// NOTE: (May 2024) This component handles redirects that *start at hashlinks*.
// This can only be done on the client, since the server cannot see the hash.
const clientRedirectsMap = {
"/repo/docs": {
"/docs": {
"#monorepos": { hash: "the-monorepo-problem" },
"#examples": {
location: "/repo/docs/getting-started/installation",
location: "/docs/getting-started/installation",
hash: "start-with-an-example",
},
"#should-i-install-turborepo-globally": {
location: "/repo/docs/getting-started/installation",
location: "/docs/getting-started/installation",
hash: "global-installation",
},
"#does-turborepo-collect-any-personally-identifiable-information-when-using-remote-caching":
{
location: "/repo/docs/telemetry",
location: "/docs/telemetry",
},
"#can-i-use-turborepo-with-a-monorepo-that-non-js-code": {
location: "/repo/docs/guides/multi-language",
location: "/docs/guides/multi-language",
},
"#why-isnt-my-global-turbo-working-as-expected": {
location: "/repo/docs/getting-started/installation",
location: "/docs/getting-started/installation",
hash: "global-installation",
},
"#do-i-have-to-use-remote-caching-to-use-turborepo": {
location: "/repo/docs/core-concepts/remote-caching",
location: "/docs/core-concepts/remote-caching",
},
"#do-i-have-to-use-vercel-to-use-turborepo": {
location: "/repo/docs/core-concepts/remote-caching",
location: "/docs/core-concepts/remote-caching",
},
"#does-turborepo-collect-any-personally-identifiable-information": {
location: "/repo/docs/telemetry",
location: "/docs/telemetry",
},
"#does-turborepo--remote-caching-store-my-source-code": {
location: "/repo/docs/crafting-your-repository/caching",
location: "/docs/crafting-your-repository/caching",
hash: "what-gets-cached",
},
"#can-i-use-turborepo-with-a-different-remote-cache-provider-other-than-vercel":
{
location: "/repo/docs/core-concepts/remote-caching",
location: "/docs/core-concepts/remote-caching",
},
"#how-can-i-retain-fast-refresh-in-my-turborepo-when-using-multiple-nextjs-applications":
{
location: "/repo/docs/core-concepts/internal-packages",
location: "/docs/core-concepts/internal-packages",
hash: "just-in-time-packages",
},
"#what-does-experimental-mean": {
location: "/governance",
hash: "#stability-and-release-phases",
},
},
"/repo/docs/getting-started/installation": {
"/docs/getting-started/installation": {
"#install-globally": { hash: "global-installation" },
"#install-per-repository": { hash: "repository-installation" },
},
"/repo/docs/crafting-your-repository/caching": {
"/docs/crafting-your-repository/caching": {
"#handling-nodejs-versions": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
},
"#hashing": {
hash: "task-inputs",
},
"#handling-platforms-and-other-arbitrary-hash-contributors": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
hash: "#operating-systems-architecture-and-other-arbitrary-conditions",
},
"#1-write-an-arbitrary-file-to-disk": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
hash: "1-write-an-arbitrary-file-to-disk",
},
"#2-add-the-file-to-your-gitignore": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
hash: "#2-add-the-file-to-your-gitignore",
},
"#3-add-the-file-to-the-hash": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
hash: "#3-add-the-file-to-the-hash",
},
"#4-generate-the-file-before-running-turbo": {
location: "/repo/docs/guides/handling-platforms",
location: "/docs/guides/handling-platforms",
hash: "#4-generate-the-file-before-running-turbo",
},
},
"/repo/docs/crafting-your-repository/running-tasks": {
"/docs/crafting-your-repository/running-tasks": {
"#most-tools-dont-optimize-for-speed": {
location: "/repo/docs/crafting-your-repository/configuring-tasks",
location: "/docs/crafting-your-repository/configuring-tasks",
},
"#turborepo-can-multitask": {
location: "/repo/docs/crafting-your-repository/configuring-tasks",
location: "/docs/crafting-your-repository/configuring-tasks",
},
"#defining-a-pipeline": {
location: "/repo/docs/crafting-your-repository/configuring-tasks",
location: "/docs/crafting-your-repository/configuring-tasks",
},
"#running-tasks-from-the-root": {
location: "/repo/docs/crafting-your-repository/configuring-tasks",
location: "/docs/crafting-your-repository/configuring-tasks",
hash: "registering-root-tasks",
},
"#incremental-adoption": {
location: "/repo/docs/crafting-your-repository/configuring-tasks",
location: "/docs/crafting-your-repository/configuring-tasks",
hash: "when-to-use-root-tasks",
},
"#filtering-by-package-name": {
location: "/repo/docs/crafting-your-repository/running-tasks",
location: "/docs/crafting-your-repository/running-tasks",
hash: "filtering-by-package",
},
},
"/repo/docs/crafting-your-repository/using-environment-variables": {
"/docs/crafting-your-repository/using-environment-variables": {
"#globalenv": { hash: "adding-environment-variables-to-task-hashes" },
"#pipelinetaskenv": { hash: "adding-environment-variables-to-task-hashes" },
"#loose--strict-environment-modes": {
hash: "environment-modes",
},
"#wildcards": {
location: "/repo/docs/reference/configuration",
location: "/docs/reference/configuration",
hash: "wildcards",
},
"#syntax": {
location: "/repo/docs/reference/configuration",
location: "/docs/reference/configuration",
hash: "wildcards",
},
"#system-environment-variables": {
location: "/repo/docs/reference/system-environment-variables",
location: "/docs/reference/system-environment-variables",
},
"#hashed-environment-variables": {
hash: "strict-mode",
Expand All @@ -151,7 +151,7 @@ const clientRedirectsMap = {
hash: "avoid-creating-or-mutating-environment-variables-at-runtime",
},
},
"/repo/docs/crafting-your-repository/configuring-tasks": {
"/docs/crafting-your-repository/configuring-tasks": {
"#from-the-same-workspace": {
hash: "depending-on-tasks-in-the-same-package",
},
Expand All @@ -165,19 +165,19 @@ const clientRedirectsMap = {
hash: "dependent-tasks-that-can-be-ran-in-parallel",
},
},
"/repo/docs/reference/configuration": {
"/docs/reference/configuration": {
"#glob-specification-for-paths": {
location: "/repo/docs/reference/globs",
location: "/docs/reference/globs",
},
},
"/repo/docs/reference": {
"/docs/reference": {
"#global-arguments": {
hash: "global-flags",
},
},
"/repo/docs/core-concepts/internal-packages": {
"/docs/core-concepts/internal-packages": {
"#anatomy-of-a-package": {
location: "/repo/docs/crafting-your-repository/structuring-a-repository",
location: "/docs/crafting-your-repository/structuring-a-repository",
hash: "anatomy-of-a-package",
},
},
Expand Down
6 changes: 3 additions & 3 deletions docs/site/app/_components/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ const navigation = {
{ name: "Governance", href: "/governance" },
],
repo: [
{ name: "Documentation", href: "/repo/docs" },
{ name: "Documentation", href: "/docs" },
{
name: "API Reference",
href: "/repo/docs/reference",
href: "/docs/reference",
},
{ name: "Telemetry", href: "/repo/docs/telemetry" },
{ name: "Telemetry", href: "/docs/telemetry" },
],
support: [
{
Expand Down
2 changes: 1 addition & 1 deletion docs/site/app/source.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const extraPages = loader({
});

export const repoDocsPages = loader({
baseUrl: "/repo/docs",
baseUrl: "/docs",
source: createMDXSource(repoDocs, repoMeta),
});

Expand Down
2 changes: 1 addition & 1 deletion docs/site/components/nav/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const FOOTER_ITEMS = {
{ href: "https://vercel.com/legal/privacy-policy", label: "Privacy" },
{ href: "/terms", label: "Terms" },
{ href: "/governance", label: "Governance" },
{ href: "/repo/docs/telemetry", label: "Telemetry" },
{ href: "/docs/telemetry", label: "Telemetry" },
],
resources: [
{ href: "/blog", label: "Blog" },
Expand Down
4 changes: 2 additions & 2 deletions docs/site/components/nav/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {

export const PAGES = [
{
href: "/repo/docs",
href: "/docs",
tooltip: "Docs",
name: "docs",
},
Expand Down Expand Up @@ -94,7 +94,7 @@ export const Navigation = () => {
"text-sm transition-colors duration-100 hover:text-gray-1000 data-[active=true]:text-gray-1000"
)}
data-active={pageFromRoute === page.name}
scroll={page.href !== "/repo/docs"}
scroll={page.href !== "/docs"}
>
{page.tooltip}
</Link>
Expand Down
2 changes: 1 addition & 1 deletion docs/site/components/remote-cache-counter/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export function RemoteCacheCounter(): JSX.Element {
return (
<Link
className="group my-4 h-[126px] min-h-[126px] w-full overflow-hidden rounded-lg border border-transparent bg-gradient-to-r from-[#ef4444] to-[#3b82f6] bg-origin-border"
href="/repo/docs/core-concepts/remote-caching"
href="/docs/core-concepts/remote-caching"
onClick={() => track("Remote Cache counter click")}
>
<div className="bg-white p-4 dark:bg-black">
Expand Down
Loading
Loading