Skip to content

Commit

Permalink
docs(misc): fix misc issues (#22039)
Browse files Browse the repository at this point in the history
Co-authored-by: Isaac Mann <[email protected]>
  • Loading branch information
leosvelperez and isaacplmann authored Feb 28, 2024
1 parent 2fa693d commit 6576325
Show file tree
Hide file tree
Showing 33 changed files with 86 additions and 96 deletions.
12 changes: 6 additions & 6 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -8283,7 +8283,7 @@
"name": "documents",
"children": [
{
"name": "Overview of the Nx Nuxt Plugin",
"name": "Overview",
"path": "/nx-api/nuxt/documents/overview",
"id": "overview",
"isExternal": false,
Expand Down Expand Up @@ -9417,7 +9417,7 @@
"name": "documents",
"children": [
{
"name": "Nx Storybook Plugin Overview",
"name": "Overview",
"path": "/nx-api/storybook/documents/overview",
"id": "overview",
"isExternal": false,
Expand All @@ -9433,7 +9433,7 @@
"disableCollapsible": false
},
{
"name": "Storybook 7 overview",
"name": "Storybook 7",
"path": "/nx-api/storybook/documents/storybook-7-setup",
"id": "storybook-7-setup",
"isExternal": false,
Expand Down Expand Up @@ -9533,7 +9533,7 @@
"name": "documents",
"children": [
{
"name": "Overview of the Nx Vite Plugin",
"name": "Overview",
"path": "/nx-api/vite/documents/overview",
"id": "overview",
"isExternal": false,
Expand Down Expand Up @@ -9633,7 +9633,7 @@
"name": "documents",
"children": [
{
"name": "Overview of the Nx Vue Plugin",
"name": "Overview",
"path": "/nx-api/vue/documents/overview",
"id": "overview",
"isExternal": false,
Expand Down Expand Up @@ -9800,7 +9800,7 @@
"name": "documents",
"children": [
{
"name": "Overview of the Nx Webpack Plugin",
"name": "Overview",
"path": "/nx-api/webpack/documents/overview",
"id": "overview",
"isExternal": false,
Expand Down
12 changes: 6 additions & 6 deletions docs/generated/manifests/nx-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -1557,7 +1557,7 @@
"documents": {
"/nx-api/nuxt/documents/overview": {
"id": "overview",
"name": "Overview of the Nx Nuxt Plugin",
"name": "Overview",
"description": "The Nx Plugin for Nuxt contains generators for managing Nuxt applications within a Nx workspace. This page also explains how to configure Nuxt on your Nx workspace.",
"file": "generated/packages/nuxt/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -2707,7 +2707,7 @@
"documents": {
"/nx-api/storybook/documents/overview": {
"id": "overview",
"name": "Nx Storybook Plugin Overview",
"name": "Overview",
"description": "This is an overview page for the Storybook plugin in Nx. It explains what Storybook is and how to set it up in your Nx workspace.",
"file": "generated/packages/storybook/documents/overview",
"itemList": [],
Expand All @@ -2729,7 +2729,7 @@
},
"/nx-api/storybook/documents/storybook-7-setup": {
"id": "storybook-7-setup",
"name": "Storybook 7 overview",
"name": "Storybook 7",
"description": "This guide explains how you can set up Storybook version 7 in your Nx workspace. It contains information about the generators and the frameworks that are supported.",
"file": "generated/packages/storybook/documents/storybook-7-setup",
"itemList": [],
Expand Down Expand Up @@ -2821,7 +2821,7 @@
"documents": {
"/nx-api/vite/documents/overview": {
"id": "overview",
"name": "Overview of the Nx Vite Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vite contains executors and generators that support building applications using Vite. This page also explains how to configure Vite on your Nx workspace.",
"file": "generated/packages/vite/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -2910,7 +2910,7 @@
"documents": {
"/nx-api/vue/documents/overview": {
"id": "overview",
"name": "Overview of the Nx Vue Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vue contains generators for managing Vue applications and libraries within an Nx workspace. This page also explains how to configure Vue on your Nx workspace.",
"file": "generated/packages/vue/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -3060,7 +3060,7 @@
"documents": {
"/nx-api/webpack/documents/overview": {
"id": "overview",
"name": "Overview of the Nx Webpack Plugin",
"name": "Overview",
"description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.",
"file": "generated/packages/webpack/documents/overview",
"itemList": [],
Expand Down
12 changes: 6 additions & 6 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -1538,7 +1538,7 @@
"documents": [
{
"id": "overview",
"name": "Overview of the Nx Nuxt Plugin",
"name": "Overview",
"description": "The Nx Plugin for Nuxt contains generators for managing Nuxt applications within a Nx workspace. This page also explains how to configure Nuxt on your Nx workspace.",
"file": "generated/packages/nuxt/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -2680,7 +2680,7 @@
"documents": [
{
"id": "overview",
"name": "Nx Storybook Plugin Overview",
"name": "Overview",
"description": "This is an overview page for the Storybook plugin in Nx. It explains what Storybook is and how to set it up in your Nx workspace.",
"file": "generated/packages/storybook/documents/overview",
"itemList": [],
Expand All @@ -2702,7 +2702,7 @@
},
{
"id": "storybook-7-setup",
"name": "Storybook 7 overview",
"name": "Storybook 7",
"description": "This guide explains how you can set up Storybook version 7 in your Nx workspace. It contains information about the generators and the frameworks that are supported.",
"file": "generated/packages/storybook/documents/storybook-7-setup",
"itemList": [],
Expand Down Expand Up @@ -2792,7 +2792,7 @@
"documents": [
{
"id": "overview",
"name": "Overview of the Nx Vite Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vite contains executors and generators that support building applications using Vite. This page also explains how to configure Vite on your Nx workspace.",
"file": "generated/packages/vite/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -2880,7 +2880,7 @@
"documents": [
{
"id": "overview",
"name": "Overview of the Nx Vue Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vue contains generators for managing Vue applications and libraries within an Nx workspace. This page also explains how to configure Vue on your Nx workspace.",
"file": "generated/packages/vue/documents/overview",
"itemList": [],
Expand Down Expand Up @@ -3028,7 +3028,7 @@
"documents": [
{
"id": "overview",
"name": "Overview of the Nx Webpack Plugin",
"name": "Overview",
"description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.",
"file": "generated/packages/webpack/documents/overview",
"itemList": [],
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/nuxt/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The `@nx/nuxt/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `buildTargetName`, `testTargetName` and `serveTargetName` options control the names of the inferred Nuxt tasks. The default names are `build`, `test` and `serve`.
The `buildTargetName`, `testTargetName` and `serveTargetName` options control the names of the inferred Nuxt tasks. The default names are `build`, `test` and `serve`.

## Using Nuxt

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/playwright/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The `@nx/playwright/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `targetName` and `ciTargetName` options control the namea of the inferred Playwright tasks. The default names are `e2e` and `e2e-ci`.
The `targetName` and `ciTargetName` options control the name of the inferred Playwright tasks. The default names are `e2e` and `e2e-ci`.

### Splitting E2E tasks by file

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/remix/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The `@nx/remix/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `buildTargetName`, `serveTargetName`, `startTargetName` and `typecheckTargetName` options control the names of the inferred Remix tasks. The default names are `build`, `serve`, `start` and `typecheck`.
The `buildTargetName`, `serveTargetName`, `startTargetName` and `typecheckTargetName` options control the names of the inferred Remix tasks. The default names are `build`, `serve`, `start` and `typecheck`.

{% /tab %}
{% tab label="Nx < 18" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/storybook/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The `@nx/storybook/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `builtStorybookTargetName`, `serveStorybookTargetName`, `testStorybookTargetName` and `staticStorybookTargetName` options control the names of the inferred Storybook tasks. The default names are `build-storybook`, `storybook`, `test-storybook` and `static-storybook`.
The `builtStorybookTargetName`, `serveStorybookTargetName`, `testStorybookTargetName` and `staticStorybookTargetName` options control the names of the inferred Storybook tasks. The default names are `build-storybook`, `storybook`, `test-storybook` and `static-storybook`.

{% /tab %}
{% tab label="Nx < 18" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/vite/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The `@nx/vite/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `buildTargetName`, `previewTargetName`, `testTargetName`, `serveTargetName` and `serveStaticTargetName` options control the names of the inferred Vite tasks. The default names are `build`, `preview`, `test`, `serve` and `serve-static`.
The `buildTargetName`, `previewTargetName`, `testTargetName`, `serveTargetName` and `serveStaticTargetName` options control the names of the inferred Vite tasks. The default names are `build`, `preview`, `test`, `serve` and `serve-static`.

{% /tab %}
{% tab label="Nx < 18" %}
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/webpack/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The `@nx/webpack/plugin` is configured in the `plugins` array in `nx.json`.
}
```

- The `buildTargetName`, `previewTargetName`, `serveTargetName` and `serveStaticTargetName` options control the names of the inferred Webpack tasks. The default names are `build`, `preview`, `serve` and `serve-static`.
The `buildTargetName`, `previewTargetName`, `serveTargetName` and `serveStaticTargetName` options control the names of the inferred Webpack tasks. The default names are `build`, `preview`, `serve` and `serve-static`.

{% /tab %}
{% tab label="Nx < 18" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ and the version of NodeJS that we tested it against.
| Nx Version | Node Version | Typescript Version |
| --------------- | ---------------- | ------------------ |
| 13.x | 10.x, 12.x, 14.x | ~4.6.2 |
| 14.x | 12.x, 14.x, 16.x | ~4.7.2 |
| 15.x | 14.x, 16.x, 18.x | ~5.0.0 |
| 16.x | 16.x, 18.x, 20.x | ~5.1.0 |
| 17.x (previous) | 18.x, 20.x | ~5.1.0 |
| 18.x (latest) | 18.x, 20.x | ~5.1.0 |
| 17.x (previous) | 18.x, 20.x | ~5.1.0 |
| 16.x | 16.x, 18.x, 20.x | ~5.1.0 |
| 15.x | 14.x, 16.x, 18.x | ~5.0.0 |
| 14.x | 12.x, 14.x, 16.x | ~4.7.2 |
| 13.x | 10.x, 12.x, 14.x | ~4.6.2 |
12 changes: 6 additions & 6 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -2196,7 +2196,7 @@
{
"id": "overview",
"path": "/nx-api/vite",
"name": "Overview of the Nx Vite Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vite contains executors and generators that support building applications using Vite. This page also explains how to configure Vite on your Nx workspace.",
"file": "shared/packages/vite/vite-plugin"
}
Expand All @@ -2210,7 +2210,7 @@
{
"id": "overview",
"path": "/nx-api/vue",
"name": "Overview of the Nx Vue Plugin",
"name": "Overview",
"description": "The Nx Plugin for Vue contains generators for managing Vue applications and libraries within an Nx workspace. This page also explains how to configure Vue on your Nx workspace.",
"file": "shared/packages/vue/vue-plugin"
}
Expand All @@ -2224,7 +2224,7 @@
{
"id": "overview",
"path": "/nx-api/nuxt",
"name": "Overview of the Nx Nuxt Plugin",
"name": "Overview",
"description": "The Nx Plugin for Nuxt contains generators for managing Nuxt applications within a Nx workspace. This page also explains how to configure Nuxt on your Nx workspace.",
"file": "shared/packages/nuxt/nuxt-plugin"
}
Expand All @@ -2238,7 +2238,7 @@
{
"id": "overview",
"path": "/nx-api/webpack",
"name": "Overview of the Nx Webpack Plugin",
"name": "Overview",
"description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.",
"file": "shared/packages/webpack/plugin-overview"
}
Expand Down Expand Up @@ -2322,7 +2322,7 @@
"itemList": [
{
"id": "overview",
"name": "Nx Storybook Plugin Overview",
"name": "Overview",
"description": "This is an overview page for the Storybook plugin in Nx. It explains what Storybook is and how to set it up in your Nx workspace.",
"path": "/nx-api/storybook",
"file": "shared/packages/storybook/plugin-overview"
Expand All @@ -2335,7 +2335,7 @@
},
{
"id": "storybook-7-setup",
"name": "Storybook 7 overview",
"name": "Storybook 7",
"description": "This guide explains how you can set up Storybook version 7 in your Nx workspace. It contains information about the generators and the frameworks that are supported.",
"file": "shared/packages/storybook/storybook-7-setup"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/nx-cloud/features/split-e2e-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You could manually address these problems by splitting your e2e tests into small

## Set up

To enable automatically split e2e tasks, you need to turn on [inferred tasks](/concepts/inferred-tasks) for the [@nx/cypress](/nx-api/cypress) or [@nx/playwright](/nx-api/playwright) plugins. Run this command to set up inferred tasks:
To enable automatically split e2e tasks, you need to turn on [inferred tasks](/concepts/inferred-tasks#existing-nx-workspaces) for the [@nx/cypress](/nx-api/cypress) or [@nx/playwright](/nx-api/playwright) plugins. Run this command to set up inferred tasks:

{% tabs %}
{% tab label="Cypress" %}
Expand Down
3 changes: 3 additions & 0 deletions docs/shared/angular-standalone-tutorial/angular-standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ title="Tutorial: Standalone Angular Application"
Create a new Angular application with the following command:

```{% command="npx create-nx-workspace@latest myngapp --preset=angular-standalone" path="~" %}
NX Let's create a new workspace [https://nx.dev/getting-started/intro]
✔ Which bundler would you like to use? · esbuild
✔ Default stylesheet format · css
✔ Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)? · No
Expand Down
1 change: 1 addition & 0 deletions docs/shared/angular-tutorial/angular-monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ title="Tutorial: Standalone Angular Application"
Create a new Angular monorepo with the following command:

```{% command="npx create-nx-workspace@latest angular-monorepo --preset=angular-monorepo" path="~" %}
NX Let's create a new workspace [https://nx.dev/getting-started/intro]
✔ Application name · angular-store
Expand Down
12 changes: 6 additions & 6 deletions docs/shared/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ npx create-nx-workspace --pm pnpm

This will guide you through the setup, asking whether you want a monorepo or a standalone app and whether you want to start with a blank or a preconfigured setup.

```{% command="npx create-nx-workspace" path="~" %}
```{% command="npx create-nx-workspace@latest" path="~" %}
NX Let's create a new workspace [https://nx.dev/getting-started/intro]
✔ Where would you like to create your workspace? · myorg
? Which stack do you want to use? …
None: Configures a minimal structure without specific frameworks or technologies.
TS/JS: Configures a TypeScript/JavaScript package without specific frameworks or platforms.
React: Configures a React app with your framework of choice.
Angular: Configures a Angular app with modern tooling.
Node: Configures a Node API with your framework of choice.
None: Configures a TypeScript/JavaScript project with minimal structure.
React: Configures a React application with your framework of choice.
Vue: Configures a Vue application with your framework of choice.
Angular: Configures a Angular application with modern tooling.
Node: Configures a Node API application with your framework of choice.
```

Once you've created your workspace, you can
Expand Down
6 changes: 3 additions & 3 deletions docs/shared/guides/nx-and-angular-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Here's a quick side-by-side overview comparing the features between the Angular

{% callout type="info" title="Notes" %}

\* You can setup a monorepo with the Angular CLI creating buildable Angular ng-packagr projects, but the DX is not as optimized compared to what you'd get with Nx.`
\* You can setup a monorepo with the Angular CLI creating buildable Angular ng-packagr projects, but the DX is not as optimized compared to what you'd get with Nx.

\*\* The Angular CLI has a [caching mechanism](https://angular.io/cli/cache) which persists the Webpack/ESBuild/"TS incremental build info" cache to disk. Nx leverages that cache as well but in addition adds a more powerful process-level caching on top that is framework agnostic.`
\*\* The Angular CLI has a [caching mechanism](https://angular.io/cli/cache) which persists the Webpack/ESBuild/"TS incremental build info" cache to disk. Nx leverages that cache as well but in addition adds a more powerful process-level caching on top that is framework agnostic.

{% /callout %}

Expand Down Expand Up @@ -140,7 +140,7 @@ Nx comes with slightly different terminology than the Angular CLI for some featu
npx nx g @nx/angular:component my-component
```

You can also run Angular Schematics through the Nx ClI. So something like this works as well:
You can also run Angular Schematics through the Nx CLI. So something like this works as well:

```shell
npx nx g @schematics/angular:component my-component
Expand Down
4 changes: 2 additions & 2 deletions docs/shared/guides/nx-devkit-angular-devkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ The Nx CLI can invoke Nx Generator or Angular Schematics directly. When the user

```shell
nx g mygenerator params
nx g mygenerator params # will work exactly the same as the line above
nx g myschematic params
```

The Nx CLI will see what type of generator `mygenerator` is and will invoke it using the right machinery. The user doesn't have to know how the generator is implemented.
The Nx CLI will identify whether it is running an Nx generator or an Angular schematic and will invoke it using the right machinery. The user doesn't have to know how the generator is implemented.

At times, however, it might be useful to use an Nx Devkit generator in an Angular Schematic or vice versa.

Expand Down
Loading

0 comments on commit 6576325

Please sign in to comment.