From 3152eecd300e4df596dd9f0fb8062769c63ab53f Mon Sep 17 00:00:00 2001 From: Colum Ferry Date: Fri, 26 Jan 2024 10:50:05 +0000 Subject: [PATCH] docs(core): update wording around guiding user to graph --- packages/nx/src/command-line/init/init-v2.ts | 4 +- .../generate-workspace-files.spec.ts.snap | 96 +++++++++---------- .../new/files-readme/README.md.template | 4 +- 3 files changed, 52 insertions(+), 52 deletions(-) diff --git a/packages/nx/src/command-line/init/init-v2.ts b/packages/nx/src/command-line/init/init-v2.ts index c8b469d3eb5eb..65b5c8e2671ef 100644 --- a/packages/nx/src/command-line/init/init-v2.ts +++ b/packages/nx/src/command-line/init/init-v2.ts @@ -106,10 +106,10 @@ export async function initHandler(options: InitArgs): Promise { } output.log({ - title: '👀 Explore the Graph of Your Workspace', + title: '👀 Explore Your Workspace', bodyLines: [ `Run "nx graph" to show the graph of the workspace. It will show tasks that you can run with Nx.`, - `Read this guide on exploring the graph: https://nx.dev/core-features/explore-graph`, + `Read this guide on exploring your workspace: https://nx.dev/core-features/explore-graph`, ], }); } diff --git a/packages/workspace/src/generators/new/__snapshots__/generate-workspace-files.spec.ts.snap b/packages/workspace/src/generators/new/__snapshots__/generate-workspace-files.spec.ts.snap index 961bf93a81f3d..c7255c544c923 100644 --- a/packages/workspace/src/generators/new/__snapshots__/generate-workspace-files.spec.ts.snap +++ b/packages/workspace/src/generators/new/__snapshots__/generate-workspace-files.spec.ts.snap @@ -57,12 +57,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -129,12 +129,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -197,12 +197,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -265,12 +265,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -333,12 +333,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -401,12 +401,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -473,12 +473,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -541,12 +541,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -613,12 +613,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -685,12 +685,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -757,12 +757,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -825,12 +825,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -897,12 +897,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -969,12 +969,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1041,12 +1041,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1113,12 +1113,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1181,12 +1181,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1253,12 +1253,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1321,12 +1321,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1389,12 +1389,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1461,12 +1461,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1533,12 +1533,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1605,12 +1605,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! @@ -1673,12 +1673,12 @@ Nx comes with local caching already built-in (check your \`nx.json\`). On CI you - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run \`nx graph\` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us! diff --git a/packages/workspace/src/generators/new/files-readme/README.md.template b/packages/workspace/src/generators/new/files-readme/README.md.template index 5292144ead297..d29462d3fb2d0 100644 --- a/packages/workspace/src/generators/new/files-readme/README.md.template +++ b/packages/workspace/src/generators/new/files-readme/README.md.template @@ -56,11 +56,11 @@ Nx comes with local caching already built-in (check your `nx.json`). On CI you m - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) - [Learn more how to setup CI](https://nx.dev/recipes/ci) -## Explore the Graph of Your Workspace +## Explore the Project Graph Run `nx graph` to show the graph of the workspace. It will show tasks that you can run with Nx. -- [Learn more about Exploring the Graph](https://nx.dev/core-features/explore-graph) +- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) ## Connect with us!