diff --git a/docs/pages/docs/configuring-ci/meta.json b/docs/pages/docs/configuring-ci/meta.json new file mode 100644 index 0000000000000..a9375700f11eb --- /dev/null +++ b/docs/pages/docs/configuring-ci/meta.json @@ -0,0 +1,4 @@ +{ + "using-github-actions-and-turborepo": "Using GitHub Actions and Turborepo", + "using-circleci-and-turborepo": "Using CircleCI and Turborepo", +} diff --git a/docs/pages/docs/configuring-ci/using-circleci-and-turborepo b/docs/pages/docs/configuring-ci/using-circleci-and-turborepo new file mode 100644 index 0000000000000..c53507e011740 --- /dev/null +++ b/docs/pages/docs/configuring-ci/using-circleci-and-turborepo @@ -0,0 +1,4 @@ +--- +title: Using CircleCI and Turborepo +description: Optimize Turborepo with CircleCI +--- diff --git a/docs/pages/docs/guides/continuous-integration.mdx b/docs/pages/docs/configuring-ci/using-github-actions-and-turborepo.mdx similarity index 95% rename from docs/pages/docs/guides/continuous-integration.mdx rename to docs/pages/docs/configuring-ci/using-github-actions-and-turborepo.mdx index 745f2c602949b..a13be31eee715 100644 --- a/docs/pages/docs/guides/continuous-integration.mdx +++ b/docs/pages/docs/configuring-ci/using-github-actions-and-turborepo.mdx @@ -1,6 +1,6 @@ --- -title: Continuous Integration -description: Recipes for using Turborepo with GitHub Actions, CircleCI, and other continuous integration providers. +title: Using GitHub Actions and Turborepo +description: Optimize Turborepo with GitHub Actions --- # Continuous Integration @@ -86,7 +86,7 @@ Copy the value to a safe place. You'll need it in a moment. ```yaml highlight="6-8" # ... - + jobs: build: name: Build and Test diff --git a/docs/pages/docs/features/caching.mdx b/docs/pages/docs/core-concepts/caching.mdx similarity index 100% rename from docs/pages/docs/features/caching.mdx rename to docs/pages/docs/core-concepts/caching.mdx diff --git a/docs/pages/docs/features/filtering.mdx b/docs/pages/docs/core-concepts/filtering.mdx similarity index 100% rename from docs/pages/docs/features/filtering.mdx rename to docs/pages/docs/core-concepts/filtering.mdx diff --git a/docs/pages/docs/features/meta.json b/docs/pages/docs/core-concepts/meta.json similarity index 100% rename from docs/pages/docs/features/meta.json rename to docs/pages/docs/core-concepts/meta.json diff --git a/docs/pages/docs/features/pipelines.mdx b/docs/pages/docs/core-concepts/pipelines.mdx similarity index 100% rename from docs/pages/docs/features/pipelines.mdx rename to docs/pages/docs/core-concepts/pipelines.mdx diff --git a/docs/pages/docs/features/remote-caching.mdx b/docs/pages/docs/core-concepts/remote-caching.mdx similarity index 100% rename from docs/pages/docs/features/remote-caching.mdx rename to docs/pages/docs/core-concepts/remote-caching.mdx diff --git a/docs/pages/docs/features/scopes.mdx b/docs/pages/docs/core-concepts/scopes.mdx similarity index 100% rename from docs/pages/docs/features/scopes.mdx rename to docs/pages/docs/core-concepts/scopes.mdx diff --git a/docs/pages/docs/framework-starters/meta.json b/docs/pages/docs/framework-starters/meta.json new file mode 100644 index 0000000000000..def0a1620f182 --- /dev/null +++ b/docs/pages/docs/framework-starters/meta.json @@ -0,0 +1,4 @@ +{ + "nextjs-on-turborepo": "Next.js on Turborepo", + "svelte-on-turborepo": "Svelte on Turborepo", +} diff --git a/docs/pages/docs/framework-starters/nextjs-on-turborepo b/docs/pages/docs/framework-starters/nextjs-on-turborepo new file mode 100644 index 0000000000000..d532037fe89ca --- /dev/null +++ b/docs/pages/docs/framework-starters/nextjs-on-turborepo @@ -0,0 +1,12 @@ +--- +title: Next.js on Turborepo +description: Use this starter and guide to build a project with Next.js on Turborepo +--- + +### Introduction + +### Configure your project + +### Build your projects + +### Next steps diff --git a/docs/pages/docs/framework-starters/svelte-on-turborepo.mdx b/docs/pages/docs/framework-starters/svelte-on-turborepo.mdx new file mode 100644 index 0000000000000..d1fcff99808f8 --- /dev/null +++ b/docs/pages/docs/framework-starters/svelte-on-turborepo.mdx @@ -0,0 +1,12 @@ +--- +title: Svelte on Turborepo +description: Use this starter and guide to build a project with Sveltekit on Turborepo +--- + +### Introduction + +### Configure your project + +### Build your projects + +### Next steps diff --git a/docs/pages/docs/getting-started/meta.json b/docs/pages/docs/getting-started/meta.json new file mode 100644 index 0000000000000..a8c86443001dc --- /dev/null +++ b/docs/pages/docs/getting-started/meta.json @@ -0,0 +1,4 @@ +{ + "monorepo-tools": "Monorepo tools", + "quickstart": "Quickstart", +} diff --git a/docs/pages/docs/guides/monorepo-tools.mdx b/docs/pages/docs/getting-started/monorepo-tools.mdx similarity index 99% rename from docs/pages/docs/guides/monorepo-tools.mdx rename to docs/pages/docs/getting-started/monorepo-tools.mdx index 27a735c98c8c5..ff8bb1c3908fe 100644 --- a/docs/pages/docs/guides/monorepo-tools.mdx +++ b/docs/pages/docs/getting-started/monorepo-tools.mdx @@ -1,5 +1,5 @@ --- -title: Awesome Monorepo Tools +title: Monorepo tools description: Versioning, publishing, changelogs, linting, testing, automation, and more. --- diff --git a/docs/pages/docs/getting-started.mdx b/docs/pages/docs/getting-started/quickstart.mdx similarity index 99% rename from docs/pages/docs/getting-started.mdx rename to docs/pages/docs/getting-started/quickstart.mdx index b97ab33c0a192..965eb6b929933 100644 --- a/docs/pages/docs/getting-started.mdx +++ b/docs/pages/docs/getting-started/quickstart.mdx @@ -1,5 +1,5 @@ --- -title: Getting Started +title: Quickstart description: Create your first monorepo or add Turborepo to an existing project. --- @@ -84,7 +84,7 @@ Your pipeline both defines the way in which your NPM `package.json` scripts rela "build": { "dependsOn": ["^build"], // note: output globs are relative to each package's `package.json` - // (and not the monorepo root) + // (and not the monorepo root) "outputs": [".next/**"] }, "test": { diff --git a/docs/pages/docs/guides/meta.json b/docs/pages/docs/guides/meta.json deleted file mode 100644 index 2510bbb2ba553..0000000000000 --- a/docs/pages/docs/guides/meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "continuous-integration": "Continuous Integration", - "migrate-from-lerna": "Migrate from Lerna", - "monorepo-tools": "Complementary Tools" -} diff --git a/docs/pages/docs/meta.json b/docs/pages/docs/meta.json index 534e1bc6a0366..7a25d26f2eabf 100644 --- a/docs/pages/docs/meta.json +++ b/docs/pages/docs/meta.json @@ -1,8 +1,10 @@ { "index": "Introduction", - "getting-started": "Getting Started", - "features": "Features", - "guides": "Guides", + "getting-started": "Getting started", + "core-concepts": "Core concepts", + "framework-starters": "Framework starters", + "migration": "Migration", + "configuring-ci": "Configuring CI", "reference": "API Reference", "changelog": { "title": "Changelog", diff --git a/docs/pages/docs/migration/meta.json b/docs/pages/docs/migration/meta.json new file mode 100644 index 0000000000000..96f634733c2a4 --- /dev/null +++ b/docs/pages/docs/migration/meta.json @@ -0,0 +1,4 @@ +{ + "migrate-from-lerna": "Migrate from Lerna", + "migrate-from-nx": "Migrate from Nx", +} diff --git a/docs/pages/docs/guides/migrate-from-lerna.mdx b/docs/pages/docs/migration/migrate-from-lerna.mdx similarity index 100% rename from docs/pages/docs/guides/migrate-from-lerna.mdx rename to docs/pages/docs/migration/migrate-from-lerna.mdx diff --git a/docs/pages/docs/migration/migrate-from-nx.mdx b/docs/pages/docs/migration/migrate-from-nx.mdx new file mode 100644 index 0000000000000..11f3189f63564 --- /dev/null +++ b/docs/pages/docs/migration/migrate-from-nx.mdx @@ -0,0 +1,4 @@ +--- +title: Migrate from Nx +description: Learn how to incrementally adopt Turborepo from your existing Nx monorepo. +---