这是indexloc提供的服务，不要输入任何密码
Skip to content

WIP restructure docs #1078

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

WIP restructure docs #1078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b4fa2e
add section for starters
megbird Apr 19, 2022
e2ce18d
shuffling
megbird Apr 19, 2022
02d587e
reorganize navbar to make room for recipes
megbird Apr 19, 2022
af486e1
more restructuring
megbird Apr 19, 2022
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
4 changes: 4 additions & 0 deletions docs/pages/docs/configuring-ci/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"using-github-actions-and-turborepo": "Using GitHub Actions and Turborepo",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might use "with" instead of "and."

"using-circleci-and-turborepo": "Using CircleCI and Turborepo",
}
4 changes: 4 additions & 0 deletions docs/pages/docs/configuring-ci/using-circleci-and-turborepo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Using CircleCI and Turborepo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ethan-Arrowood just landed a PR that added CircleCI docs. 👍

description: Optimize Turborepo with CircleCI
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optimize CI on CircleCI with Turborepo

---
6 changes: 3 additions & 3 deletions ...es/docs/guides/continuous-integration.mdx → ...ci/using-github-actions-and-turborepo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optimize CI on GitHub Actions with Turborepo

---

# Continuous Integration
Expand Down Expand Up @@ -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
Expand Down
0 docs/pages/docs/features/caching.mdx → docs/pages/docs/core-concepts/caching.mdx
View file
Open in desktop
File renamed without changes.
0 docs/pages/docs/features/filtering.mdx → docs/pages/docs/core-concepts/filtering.mdx
View file
Open in desktop
File renamed without changes.
0 docs/pages/docs/features/meta.json → docs/pages/docs/core-concepts/meta.json
View file
Open in desktop
File renamed without changes.
0 docs/pages/docs/features/pipelines.mdx → docs/pages/docs/core-concepts/pipelines.mdx
View file
Open in desktop
File renamed without changes.
0 docs/pages/docs/features/remote-caching.mdx → ...ges/docs/core-concepts/remote-caching.mdx
View file
Open in desktop
File renamed without changes.
0 docs/pages/docs/features/scopes.mdx → docs/pages/docs/core-concepts/scopes.mdx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/pages/docs/framework-starters/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"nextjs-on-turborepo": "Next.js on Turborepo",
"svelte-on-turborepo": "Svelte on Turborepo",
}
12 changes: 12 additions & 0 deletions docs/pages/docs/framework-starters/nextjs-on-turborepo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

File extension needs to be added.

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
12 changes: 12 additions & 0 deletions docs/pages/docs/framework-starters/svelte-on-turborepo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions docs/pages/docs/getting-started/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"monorepo-tools": "Monorepo tools",
"quickstart": "Quickstart",
}
2 changes: 1 addition & 1 deletion docs/pages/docs/guides/monorepo-tools.mdx → ...s/docs/getting-started/monorepo-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Awesome Monorepo Tools
title: Monorepo tools
description: Versioning, publishing, changelogs, linting, testing, automation, and more.
---

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/docs/getting-started.mdx → ...pages/docs/getting-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Getting Started
title: Quickstart
description: Create your first monorepo or add Turborepo to an existing project.
---

Expand Down Expand Up @@ -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": {
Expand Down
5 changes: 0 additions & 5 deletions docs/pages/docs/guides/meta.json
View file
Open in desktop

This file was deleted.

8 changes: 5 additions & 3 deletions docs/pages/docs/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/docs/migration/meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"migrate-from-lerna": "Migrate from Lerna",
"migrate-from-nx": "Migrate from Nx",
}
0 .../pages/docs/guides/migrate-from-lerna.mdx → ...ges/docs/migration/migrate-from-lerna.mdx
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/pages/docs/migration/migrate-from-nx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Migrate from Nx
description: Learn how to incrementally adopt Turborepo from your existing Nx monorepo.
---