diff --git a/docs/fundamentals/build-full-stack-applications.md b/docs/a/fundamentals/build-full-stack-applications.md similarity index 98% rename from docs/fundamentals/build-full-stack-applications.md rename to docs/a/fundamentals/build-full-stack-applications.md index 5d49c770b72b6..d8d77db3da309 100644 --- a/docs/fundamentals/build-full-stack-applications.md +++ b/docs/a/fundamentals/build-full-stack-applications.md @@ -351,7 +351,7 @@ export class AppController { } ``` -After this refactor, the backend and the frontend will share the same definition of `Ticket` and never get out of sync. Being able to factor code into a lot of small libraries with a well-defined public API, which you can then use across both the backend and the frontend, is a key feature of Nx. You can read more about it in our [Develop like Google Guide](develop-like-google). +After this refactor, the backend and the frontend will share the same definition of `Ticket` and never get out of sync. Being able to factor code into a lot of small libraries with a well-defined public API, which you can then use across both the backend and the frontend, is a key feature of Nx. You can read more about it in our [Develop like Google Guide](/a/fundamentals/develop-like-google). ## Nx is Smart @@ -365,7 +365,7 @@ npm run dep-graph ![Full Stack Dependencies](./full-stack-deps.png) -If you change the data library, Nx will know that both the backend and the frontend can be affected by the change. This information can be used to test and build all areas affected by a change making Nx a powerful full-stack development environment that scales. You can read more about this Nx capability in [Building Like Google](develop-like-google). +If you change the data library, Nx will know that both the backend and the frontend can be affected by the change. This information can be used to test and build all areas affected by a change making Nx a powerful full-stack development environment that scales. You can read more about this Nx capability in [Building Like Google](/a/fundamentals/develop-like-google). ## Summary diff --git a/docs/fundamentals/develop-like-google.md b/docs/a/fundamentals/develop-like-google.md similarity index 96% rename from docs/fundamentals/develop-like-google.md rename to docs/a/fundamentals/develop-like-google.md index 672f67e62bdb4..afd163c05b794 100644 --- a/docs/fundamentals/develop-like-google.md +++ b/docs/a/fundamentals/develop-like-google.md @@ -193,7 +193,7 @@ An Nx workspace can contain dozens (or hundreds) of applications and libraries. Previously, a senior architect would create an ad-hoc dependency diagram and upload it to a corporate wiki. The diagram is not even correct on Day 1, and gets more and more out of sync with every passing day. -With Nx, you can do better than that. You can run `yarn dep-graph` to see a current dependency diagram of the workspace: what apps and libs are there, how they depend on each other, what is loaded lazily and what is not. Nx uses code analysis to collect this information. Read more about [Analyzing and Visualizing Workspaces](/guides/monorepo-dependency-diagrams). +With Nx, you can do better than that. You can run `yarn dep-graph` to see a current dependency diagram of the workspace: what apps and libs are there, how they depend on each other, what is loaded lazily and what is not. Nx uses code analysis to collect this information. Read more about [Analyzing and Visualizing Workspaces](/a/guides/monorepo-dependency-diagrams). ![Monorepo Diagram](./monorepo-diagram.png) @@ -217,7 +217,7 @@ yarn affected --target=lint --base=master # reruns any target (for instance lint Nx will topologically sort the projects, and will run what it can in parallel. The fact that Nx can use its dependency graph to rebuild and retest the minimal number of projects necessary is crucial. Without this the repo will not scale beyond a handful of projects. -Read more about how to use `affected:*` commands [here](/guides/monorepo-affected). +Read more about how to use `affected:*` commands [here](/a/guides/monorepo-affected). ### Imposing Constraints on the Dependency Graph @@ -256,7 +256,7 @@ For instance, with this configuration, when you import private client code from ![Lint Error](./lint-error.png) -Read more about this feature [here](/guides/monorepo-tags). +Read more about this feature [here](/a/guides/monorepo-tags). ## Tools and Automation @@ -264,7 +264,7 @@ In addition to implementing monorepo-style of development, Nx brings in another ### Workspace Schematics -Schematics is what what powers all Angular CLI (and Nx) code generation. With Nx, you can easily create workspace-specific schematics that you can then use to enforce your own best practices. Read more about [Workspace Schematics](/guides/tools-workspace-schematics). +Schematics is what what powers all Angular CLI (and Nx) code generation. With Nx, you can easily create workspace-specific schematics that you can then use to enforce your own best practices. Read more about [Workspace Schematics](/a/guides/tools-workspace-schematics). ### Code Formatting @@ -276,7 +276,7 @@ yarn format:write # formats the files yarn format:check # checks that the formatting is correct (used in CI) ``` -Read more about it [here](/guides/modernize-prettier). +Read more about it [here](/a/guides/modernize-prettier). ## Understanding Nx.json @@ -340,7 +340,7 @@ In the above example, any change to `package.json` will only affect `mylib`. } ``` -The `tags` array is used to impose constraints on the dependency graph. Read more about it [here](/guides/monorepo-tags). +The `tags` array is used to impose constraints on the dependency graph. Read more about it [here](/a/guides/monorepo-tags). Nx uses its advanced code analysis to construct a dependency graph of all applications and libraries. Some dependencies, however, cannot be determined statically. You can use the `implicitDependencies` array to list the dependencies that cannot be determined statically. diff --git a/docs/fundamentals/full-stack-app.png b/docs/a/fundamentals/full-stack-app.png similarity index 100% rename from docs/fundamentals/full-stack-app.png rename to docs/a/fundamentals/full-stack-app.png diff --git a/docs/fundamentals/full-stack-deps.png b/docs/a/fundamentals/full-stack-deps.png similarity index 100% rename from docs/fundamentals/full-stack-deps.png rename to docs/a/fundamentals/full-stack-deps.png diff --git a/docs/fundamentals/lint-error.png b/docs/a/fundamentals/lint-error.png similarity index 100% rename from docs/fundamentals/lint-error.png rename to docs/a/fundamentals/lint-error.png diff --git a/docs/fundamentals/monorepo-diagram-affected.png b/docs/a/fundamentals/monorepo-diagram-affected.png similarity index 100% rename from docs/fundamentals/monorepo-diagram-affected.png rename to docs/a/fundamentals/monorepo-diagram-affected.png diff --git a/docs/fundamentals/monorepo-diagram.png b/docs/a/fundamentals/monorepo-diagram.png similarity index 100% rename from docs/fundamentals/monorepo-diagram.png rename to docs/a/fundamentals/monorepo-diagram.png diff --git a/docs/fundamentals/nest-logo.png b/docs/a/fundamentals/nest-logo.png similarity index 100% rename from docs/fundamentals/nest-logo.png rename to docs/a/fundamentals/nest-logo.png diff --git a/docs/fundamentals/prettier-logo.png b/docs/a/fundamentals/prettier-logo.png similarity index 100% rename from docs/fundamentals/prettier-logo.png rename to docs/a/fundamentals/prettier-logo.png diff --git a/docs/fundamentals/use-modern-tools.md b/docs/a/fundamentals/use-modern-tools.md similarity index 98% rename from docs/fundamentals/use-modern-tools.md rename to docs/a/fundamentals/use-modern-tools.md index 4bb0846dac5f7..66060b2ee1bdb 100644 --- a/docs/fundamentals/use-modern-tools.md +++ b/docs/a/fundamentals/use-modern-tools.md @@ -90,7 +90,7 @@ ng g @nrwl/node:application api # Create a Node Application ## Cypress -![Cypress logo](./cypress-logo.png) +![Cypress logo](../../shared/cypress-logo.png) Cypress is an e2e test runner built for modern web. It has a lot of great features: @@ -149,7 +149,7 @@ To use Protractor instead of Cypress, run `ng g @nrwl/angular:application fronte ## Jest -![Jest logo](./jest-logo.png) +![Jest logo](../../shared/jest-logo.png) Jest is a fast 0-setup testing framework from Facebook. diff --git a/docs/getting-started/about.md b/docs/a/getting-started/about.md similarity index 100% rename from docs/getting-started/about.md rename to docs/a/getting-started/about.md diff --git a/docs/getting-started/create-workspace.gif b/docs/a/getting-started/create-workspace.gif similarity index 100% rename from docs/getting-started/create-workspace.gif rename to docs/a/getting-started/create-workspace.gif diff --git a/docs/getting-started/dep-graph.png b/docs/a/getting-started/dep-graph.png similarity index 100% rename from docs/getting-started/dep-graph.png rename to docs/a/getting-started/dep-graph.png diff --git a/docs/getting-started/getting-started.md b/docs/a/getting-started/getting-started.md similarity index 100% rename from docs/getting-started/getting-started.md rename to docs/a/getting-started/getting-started.md diff --git a/docs/getting-started/lint-error.png b/docs/a/getting-started/lint-error.png similarity index 100% rename from docs/getting-started/lint-error.png rename to docs/a/getting-started/lint-error.png diff --git a/docs/getting-started/nx-and-cli.md b/docs/a/getting-started/nx-and-cli.md similarity index 96% rename from docs/getting-started/nx-and-cli.md rename to docs/a/getting-started/nx-and-cli.md index 38980c05ace45..9dc49bc903b75 100644 --- a/docs/getting-started/nx-and-cli.md +++ b/docs/a/getting-started/nx-and-cli.md @@ -40,7 +40,7 @@ ng add @nrwl/express # Add Express capabilities to a workspace ng add @nrwl/node # Add Node capabilities to a workspace ``` -Finally, you can run `ng serve backend` and `ng serve frontend`. There is a lot more to full-stack development in Nx, which you can read about [here](/fundamentals/build-full-stack-applications). +Finally, you can run `ng serve backend` and `ng serve frontend`. There is a lot more to full-stack development in Nx, which you can read about [here](/a/fundamentals/build-full-stack-applications). ## Use effective development practices pioneered at Google @@ -121,7 +121,7 @@ This is a hard requirement for monorepo-style development. Nx implements it. In addition to using the monorepo, Google is also known for its use of automation and tooling. Nx adds powerful capabilities helping your team promote best practices and ensure consistency. -Read more about how Nx helps you develop like Google [here](/fundamentals/develop-like-google). +Read more about how Nx helps you develop like Google [here](/a/fundamentals/develop-like-google). ## Use Innovative Tools @@ -145,7 +145,7 @@ ng test myapp ng e2e myapp ``` -Read more about using innovative tools [here](/fundamentals/use-modern-tools). +Read more about using innovative tools [here](/a/fundamentals/use-modern-tools). ## Summary diff --git a/docs/getting-started/resources.md b/docs/a/getting-started/resources.md similarity index 100% rename from docs/getting-started/resources.md rename to docs/a/getting-started/resources.md diff --git a/docs/getting-started/what-is-nx.md b/docs/a/getting-started/what-is-nx.md similarity index 62% rename from docs/getting-started/what-is-nx.md rename to docs/a/getting-started/what-is-nx.md index f4e06e077e14d..824614da738a3 100644 --- a/docs/getting-started/what-is-nx.md +++ b/docs/a/getting-started/what-is-nx.md @@ -12,15 +12,15 @@ With Nx, you can: ## Getting Started -- New to Nx? Have a look at the [Getting Started](/getting-started/getting-started) guide. -- [How does Nx compare to the off-the-shelf Angular CLI?](/getting-started/nx-and-cli) +- New to Nx? Have a look at the [Getting Started](/a/getting-started/getting-started) guide. +- [How does Nx compare to the off-the-shelf Angular CLI?](/a/getting-started/nx-and-cli) ## Learn Nx -- [How Nx helps you use modern tools like Cypress, Jest, and Nest](/fundamentals/use-modern-tools) -- [How Nx helps you build full-stack applications using Angular and Node.js](/fundamentals/build-full-stack-applications) -- [How Nx helps you develop like Google](/fundamentals/develop-like-google) -- [Books, talks, and blog posts about Nx](/getting-started/resources) +- [How Nx helps you use modern tools like Cypress, Jest, and Nest](/a/fundamentals/use-modern-tools) +- [How Nx helps you build full-stack applications using Angular and Node.js](/a/fundamentals/build-full-stack-applications) +- [How Nx helps you develop like Google](/a/fundamentals/develop-like-google) +- [Books, talks, and blog posts about Nx](/a/getting-started/resources) ## Contribute diff --git a/docs/guides/affected.png b/docs/a/guides/affected.png similarity index 100% rename from docs/guides/affected.png rename to docs/a/guides/affected.png diff --git a/docs/guides/dependency-graph.png b/docs/a/guides/dependency-graph.png similarity index 100% rename from docs/guides/dependency-graph.png rename to docs/a/guides/dependency-graph.png diff --git a/docs/guides/misc-data-persistence.md b/docs/a/guides/misc-data-persistence.md similarity index 100% rename from docs/guides/misc-data-persistence.md rename to docs/a/guides/misc-data-persistence.md diff --git a/docs/guides/misc-ngrx.md b/docs/a/guides/misc-ngrx.md similarity index 100% rename from docs/guides/misc-ngrx.md rename to docs/a/guides/misc-ngrx.md diff --git a/docs/guides/misc-upgrade.md b/docs/a/guides/misc-upgrade.md similarity index 100% rename from docs/guides/misc-upgrade.md rename to docs/a/guides/misc-upgrade.md diff --git a/docs/guides/modernize-cypress.md b/docs/a/guides/modernize-cypress.md similarity index 98% rename from docs/guides/modernize-cypress.md rename to docs/a/guides/modernize-cypress.md index 578303a170d3c..c64be1af2eacc 100644 --- a/docs/guides/modernize-cypress.md +++ b/docs/a/guides/modernize-cypress.md @@ -1,6 +1,6 @@ # Using Cypress -![Cypress logo](../fundamentals/cypress-logo.png) +![Cypress logo](../../shared/cypress-logo.png) Cypress is an e2e test runner built for modern web. It has a lot of great features: diff --git a/docs/guides/modernize-jest.md b/docs/a/guides/modernize-jest.md similarity index 99% rename from docs/guides/modernize-jest.md rename to docs/a/guides/modernize-jest.md index a9a55b6eec96b..3df2f1a65cf72 100644 --- a/docs/guides/modernize-jest.md +++ b/docs/a/guides/modernize-jest.md @@ -1,6 +1,6 @@ # Using Jest -![Jest logo](../fundamentals/jest-logo.png) +![Jest logo](../../shared/jest-logo.png) [Jest](https://jestjs.io/) is an open source test runner created by Facebook. It is used within Facebook internally as well as many other enterprise and open source projects including Nx itself! diff --git a/docs/guides/modernize-prettier.md b/docs/a/guides/modernize-prettier.md similarity index 100% rename from docs/guides/modernize-prettier.md rename to docs/a/guides/modernize-prettier.md diff --git a/docs/guides/monorepo-affected.md b/docs/a/guides/monorepo-affected.md similarity index 100% rename from docs/guides/monorepo-affected.md rename to docs/a/guides/monorepo-affected.md diff --git a/docs/guides/monorepo-dependency-diagrams.md b/docs/a/guides/monorepo-dependency-diagrams.md similarity index 100% rename from docs/guides/monorepo-dependency-diagrams.md rename to docs/a/guides/monorepo-dependency-diagrams.md diff --git a/docs/guides/monorepo-nx-enterprise.md b/docs/a/guides/monorepo-nx-enterprise.md similarity index 100% rename from docs/guides/monorepo-nx-enterprise.md rename to docs/a/guides/monorepo-nx-enterprise.md diff --git a/docs/guides/monorepo-tags.md b/docs/a/guides/monorepo-tags.md similarity index 96% rename from docs/guides/monorepo-tags.md rename to docs/a/guides/monorepo-tags.md index 0806c10f2d60f..2a597acbb9c78 100644 --- a/docs/guides/monorepo-tags.md +++ b/docs/a/guides/monorepo-tags.md @@ -91,9 +91,9 @@ Projects without any tags cannot depend on any other projects. If you add the fo } ``` -If you try to violate the constrains, you will get an err: +If you try to violate the constrains, you will get an error: -![dependency-graph-constraints-lint-error](../fundamentals/lint-error.png) +![dependency-graph-constraints-lint-error](../getting-started/lint-error.png) ## Multiple Dimensions diff --git a/docs/guides/nx7-to-nx8.md b/docs/a/guides/nx7-to-nx8.md similarity index 97% rename from docs/guides/nx7-to-nx8.md rename to docs/a/guides/nx7-to-nx8.md index 4889ec89efb51..9398489fe09a0 100644 --- a/docs/guides/nx7-to-nx8.md +++ b/docs/a/guides/nx7-to-nx8.md @@ -4,7 +4,7 @@ If you have used Nx since before version 8, things might seem different now. Pri ## Upgrading from Nx 7 to Nx 8 -To upgrade from a Nx 7 workspace to a Nx 8 workspace, use `yarn upgrade` or `npm run update`. This will add the new packages as well as migrate features from their usages in Nx 7 to their usages in Nx 8. +To upgrade from a Nx 7 workspace to a Nx 8 workspace, use `yarn update` or `npm run update`. This will add the new packages as well as migrate features from their usages in Nx 7 to their usages in Nx 8. ## Where you can find familiar features diff --git a/docs/guides/react-affected.png b/docs/a/guides/react-affected.png similarity index 100% rename from docs/guides/react-affected.png rename to docs/a/guides/react-affected.png diff --git a/docs/guides/react-affected2.png b/docs/a/guides/react-affected2.png similarity index 100% rename from docs/guides/react-affected2.png rename to docs/a/guides/react-affected2.png diff --git a/docs/guides/react-and-angular.md b/docs/a/guides/react-and-angular.md similarity index 100% rename from docs/guides/react-and-angular.md rename to docs/a/guides/react-and-angular.md diff --git a/docs/guides/react-dep-graph.png b/docs/a/guides/react-dep-graph.png similarity index 100% rename from docs/guides/react-dep-graph.png rename to docs/a/guides/react-dep-graph.png diff --git a/docs/guides/react-serve.png b/docs/a/guides/react-serve.png similarity index 100% rename from docs/guides/react-serve.png rename to docs/a/guides/react-serve.png diff --git a/docs/guides/react.md b/docs/a/guides/react.md similarity index 100% rename from docs/guides/react.md rename to docs/a/guides/react.md diff --git a/docs/guides/tools-workspace-schematics.md b/docs/a/guides/tools-workspace-schematics.md similarity index 100% rename from docs/guides/tools-workspace-schematics.md rename to docs/a/guides/tools-workspace-schematics.md diff --git a/docs/tutorial/01-create-application.md b/docs/a/tutorial/01-create-application.md similarity index 100% rename from docs/tutorial/01-create-application.md rename to docs/a/tutorial/01-create-application.md diff --git a/docs/tutorial/02-add-e2e-test.md b/docs/a/tutorial/02-add-e2e-test.md similarity index 100% rename from docs/tutorial/02-add-e2e-test.md rename to docs/a/tutorial/02-add-e2e-test.md diff --git a/docs/tutorial/03-display-todos.md b/docs/a/tutorial/03-display-todos.md similarity index 100% rename from docs/tutorial/03-display-todos.md rename to docs/a/tutorial/03-display-todos.md diff --git a/docs/tutorial/04-connect-to-api.md b/docs/a/tutorial/04-connect-to-api.md similarity index 100% rename from docs/tutorial/04-connect-to-api.md rename to docs/a/tutorial/04-connect-to-api.md diff --git a/docs/tutorial/05-add-node-app.md b/docs/a/tutorial/05-add-node-app.md similarity index 100% rename from docs/tutorial/05-add-node-app.md rename to docs/a/tutorial/05-add-node-app.md diff --git a/docs/tutorial/06-proxy.md b/docs/a/tutorial/06-proxy.md similarity index 100% rename from docs/tutorial/06-proxy.md rename to docs/a/tutorial/06-proxy.md diff --git a/docs/tutorial/07-share-code.md b/docs/a/tutorial/07-share-code.md similarity index 100% rename from docs/tutorial/07-share-code.md rename to docs/a/tutorial/07-share-code.md diff --git a/docs/tutorial/08-create-libs.md b/docs/a/tutorial/08-create-libs.md similarity index 100% rename from docs/tutorial/08-create-libs.md rename to docs/a/tutorial/08-create-libs.md diff --git a/docs/tutorial/09-dep-graph.md b/docs/a/tutorial/09-dep-graph.md similarity index 100% rename from docs/tutorial/09-dep-graph.md rename to docs/a/tutorial/09-dep-graph.md diff --git a/docs/tutorial/10-test-affected-projects.md b/docs/a/tutorial/10-test-affected-projects.md similarity index 100% rename from docs/tutorial/10-test-affected-projects.md rename to docs/a/tutorial/10-test-affected-projects.md diff --git a/docs/tutorial/11-build-affected-projects.md b/docs/a/tutorial/11-build-affected-projects.md similarity index 100% rename from docs/tutorial/11-build-affected-projects.md rename to docs/a/tutorial/11-build-affected-projects.md diff --git a/docs/tutorial/12-summary.md b/docs/a/tutorial/12-summary.md similarity index 71% rename from docs/tutorial/12-summary.md rename to docs/a/tutorial/12-summary.md index 959072ef52aec..a866b47b363dc 100644 --- a/docs/tutorial/12-summary.md +++ b/docs/a/tutorial/12-summary.md @@ -15,6 +15,6 @@ Watch the video showing how to use Nx and Angular Console to build full-stack ap ### Read Fundamentals -- [Using Modern Tools](/fundamentals/use-modern-tools) -- [Building Full-Stack Applications](/fundamentals/build-full-stack-applications) -- [Developing Like Google: Monorepos and Automation](/fundamentals/develop-like-google) +- [Using Modern Tools](/a/fundamentals/use-modern-tools) +- [Building Full-Stack Applications](/a/fundamentals/build-full-stack-applications) +- [Developing Like Google: Monorepos and Automation](/a/fundamentals/develop-like-google) diff --git a/docs/api-npmscripts/affected-apps.md b/docs/api-workspace/npmscripts/affected-apps.md similarity index 100% rename from docs/api-npmscripts/affected-apps.md rename to docs/api-workspace/npmscripts/affected-apps.md diff --git a/docs/api-npmscripts/affected-build.md b/docs/api-workspace/npmscripts/affected-build.md similarity index 100% rename from docs/api-npmscripts/affected-build.md rename to docs/api-workspace/npmscripts/affected-build.md diff --git a/docs/api-npmscripts/affected-dep-graph.md b/docs/api-workspace/npmscripts/affected-dep-graph.md similarity index 100% rename from docs/api-npmscripts/affected-dep-graph.md rename to docs/api-workspace/npmscripts/affected-dep-graph.md diff --git a/docs/api-npmscripts/affected-e2e.md b/docs/api-workspace/npmscripts/affected-e2e.md similarity index 100% rename from docs/api-npmscripts/affected-e2e.md rename to docs/api-workspace/npmscripts/affected-e2e.md diff --git a/docs/api-npmscripts/affected-libs.md b/docs/api-workspace/npmscripts/affected-libs.md similarity index 100% rename from docs/api-npmscripts/affected-libs.md rename to docs/api-workspace/npmscripts/affected-libs.md diff --git a/docs/api-npmscripts/affected-lint.md b/docs/api-workspace/npmscripts/affected-lint.md similarity index 100% rename from docs/api-npmscripts/affected-lint.md rename to docs/api-workspace/npmscripts/affected-lint.md diff --git a/docs/api-npmscripts/affected-test.md b/docs/api-workspace/npmscripts/affected-test.md similarity index 100% rename from docs/api-npmscripts/affected-test.md rename to docs/api-workspace/npmscripts/affected-test.md diff --git a/docs/api-npmscripts/affected.md b/docs/api-workspace/npmscripts/affected.md similarity index 100% rename from docs/api-npmscripts/affected.md rename to docs/api-workspace/npmscripts/affected.md diff --git a/docs/api-npmscripts/dep-graph.md b/docs/api-workspace/npmscripts/dep-graph.md similarity index 100% rename from docs/api-npmscripts/dep-graph.md rename to docs/api-workspace/npmscripts/dep-graph.md diff --git a/docs/api-npmscripts/format-check.md b/docs/api-workspace/npmscripts/format-check.md similarity index 100% rename from docs/api-npmscripts/format-check.md rename to docs/api-workspace/npmscripts/format-check.md diff --git a/docs/api-npmscripts/format-write.md b/docs/api-workspace/npmscripts/format-write.md similarity index 100% rename from docs/api-npmscripts/format-write.md rename to docs/api-workspace/npmscripts/format-write.md diff --git a/docs/api-npmscripts/lint-files.md b/docs/api-workspace/npmscripts/lint-files.md similarity index 100% rename from docs/api-npmscripts/lint-files.md rename to docs/api-workspace/npmscripts/lint-files.md diff --git a/docs/api-npmscripts/update-check.md b/docs/api-workspace/npmscripts/update-check.md similarity index 100% rename from docs/api-npmscripts/update-check.md rename to docs/api-workspace/npmscripts/update-check.md diff --git a/docs/api-npmscripts/update-skip.md b/docs/api-workspace/npmscripts/update-skip.md similarity index 100% rename from docs/api-npmscripts/update-skip.md rename to docs/api-workspace/npmscripts/update-skip.md diff --git a/docs/api-npmscripts/update.md b/docs/api-workspace/npmscripts/update.md similarity index 100% rename from docs/api-npmscripts/update.md rename to docs/api-workspace/npmscripts/update.md diff --git a/docs/api-npmscripts/workspace-schematic-name.md b/docs/api-workspace/npmscripts/workspace-schematic-name.md similarity index 100% rename from docs/api-npmscripts/workspace-schematic-name.md rename to docs/api-workspace/npmscripts/workspace-schematic-name.md diff --git a/docs/api/home.md b/docs/api/home.md index d53f9fb7208b0..7b9637cff2d83 100644 --- a/docs/api/home.md +++ b/docs/api/home.md @@ -17,32 +17,32 @@ can see, for each package its dependencies. ## Angular -![Angular](./angular.jpg) +![Angular](/assets/content/api/angular.jpg) ## React -![React](./react.jpg) +![React](/assets/content/api/react.jpg) ## Nest -![Nest](./nest.jpg) +![Nest](/assets/content/api/nest.jpg) ## Express -![Express](./express.jpg) +![Express](/assets/content/api/express.jpg) ## Node -![Node](./node.jpg) +![Node](/assets/content/api/node.jpg) ## Cypress -![Cypress](./cypress.jpg) +![Cypress](/assets/content/api/cypress.jpg) ## Jest -![Jest](./jest.jpg) +![Jest](/assets/content/api/jest.jpg) ## Web -![Web](./web.jpg) +![Web](/assets/content/api/web.jpg) diff --git a/docs/map.json b/docs/map.json index 47b4692aab4b4..e456d0309dcc3 100644 --- a/docs/map.json +++ b/docs/map.json @@ -1,185 +1,270 @@ [ { - "name": "Getting Started", - "id": "getting-started", + "id": "a", "itemList": [ - { - "name": "What is Nx?", - "id": "what-is-nx", - "path": "getting-started/what-is-nx" - }, { "name": "Getting Started", "id": "getting-started", - "path": "getting-started/getting-started" - }, - { - "name": "Nx and Angular CLI", - "id": "nx-and-cli", - "path": "getting-started/nx-and-cli" - }, - { - "name": "Resources", - "id": "resources", - "path": "getting-started/resources" - }, - { - "name": "About", - "id": "about", - "path": "getting-started/about" - } - ] - }, - { - "name": "Tutorial", - "id": "tutorial", - "itemList": [ - { - "name": "1 - Create Application", - "id": "01-create-application", - "path": "tutorial/01-create-application" - }, - { - "name": "2 - Add E2E Test", - "id": "02-add-e2e-test", - "path": "tutorial/02-add-e2e-test" - }, - { - "name": "3 - Display Todos", - "id": "03-display-todos", - "path": "tutorial/03-display-todos" - }, - { - "name": "4 - Connect to API", - "id": "04-connect-to-api", - "path": "tutorial/04-connect-to-api" - }, - { - "name": "5 - Add Node Application", - "id": "05-add-node-app", - "path": "tutorial/05-add-node-app" - }, - { - "name": "6 - Configure Proxy", - "id": "06-proxy", - "path": "tutorial/06-proxy" - }, - { - "name": "7 - Share Code", - "id": "07-share-code", - "path": "tutorial/07-share-code" + "itemList": [ + { + "name": "What is Nx?", + "id": "what-is-nx" + }, + { + "name": "Getting Started", + "id": "getting-started" + }, + { + "name": "Nx and Angular CLI", + "id": "nx-and-cli" + }, + { + "name": "Resources", + "id": "resources" + }, + { + "name": "About", + "id": "about" + } + ] }, { - "name": "8 - Create Libraries", - "id": "08-create-libs", - "path": "tutorial/08-create-libs" + "name": "Tutorial", + "id": "tutorial", + "itemList": [ + { + "name": "1 - Create Application", + "id": "01-create-application" + }, + { + "name": "2 - Add E2E Test", + "id": "02-add-e2e-test" + }, + { + "name": "3 - Display Todos", + "id": "03-display-todos" + }, + { + "name": "4 - Connect to API", + "id": "04-connect-to-api" + }, + { + "name": "5 - Add Node Application", + "id": "05-add-node-app" + }, + { + "name": "6 - Configure Proxy", + "id": "06-proxy" + }, + { + "name": "7 - Share Code", + "id": "07-share-code" + }, + { + "name": "8 - Create Libraries", + "id": "08-create-libs" + }, + { + "name": "9 - Dep Graph", + "id": "09-dep-graph" + }, + { + "name": "10 - Test Affected Projects", + "id": "10-test-affected-projects" + }, + { + "name": "11 - Build Affected Projects", + "id": "11-build-affected-projects" + }, + { + "name": "12 - Summary", + "id": "12-summary" + } + ] }, { - "name": "9 - Dep Graph", - "id": "09-dep-graph", - "path": "tutorial/09-dep-graph" + "name": "Fundamentals", + "id": "fundamentals", + "itemList": [ + { + "name": "Using Modern Tools", + "id": "use-modern-tools" + }, + { + "name": "Building Full-Stack Applications", + "id": "build-full-stack-applications" + }, + { + "name": "Developing Like Google", + "id": "develop-like-google" + } + ] }, { - "name": "10 - Test Affected Projects", - "id": "10-test-affected-projects", - "path": "tutorial/10-test-affected-projects" - }, - { - "name": "11 - Build Affected Projects", - "id": "11-build-affected-projects", - "path": "tutorial/11-build-affected-projects" - }, - { - "name": "12 - Summary", - "id": "12-summary", - "path": "tutorial/12-summary" + "name": "Guides", + "id": "guides", + "itemList": [ + { + "name": "Using Cypress", + "id": "modernize-cypress" + }, + { + "name": "Using Jest", + "id": "modernize-jest" + }, + { + "name": "Rebuilding and Retesting What is Affected", + "id": "monorepo-affected" + }, + { + "name": "Analysing & Visualizing Workspaces", + "id": "monorepo-dependency-diagrams" + }, + { + "name": "Imposing Constraints on the Dependency Graph", + "id": "monorepo-tags" + }, + { + "name": "Using React", + "id": "react" + }, + { + "name": "Building Angular and React Applications Together With Nx", + "id": "react-and-angular" + }, + { + "name": "Setting Up NgRx", + "id": "misc-ngrx" + }, + { + "name": "Using DataPersistence", + "id": "misc-data-persistence" + }, + { + "name": "Upgrading AngularJS Applications", + "id": "misc-upgrade" + }, + { + "name": "Using Nx at Enterprises", + "id": "monorepo-nx-enterprise" + }, + { + "name": "Changes between Nx 7 and Nx 8", + "id": "nx7-to-nx8" + } + ] } ] }, + { - "name": "Fundamentals", - "id": "fundamentals", + "id": "w", "itemList": [ { - "name": "Using Modern Tools", - "id": "use-modern-tools", - "path": "fundamentals/use-modern-tools" + "name": "Getting Started", + "id": "getting-started", + "itemList": [ + { + "name": "What is Nx?", + "id": "what-is-nx" + }, + { + "name": "Getting Started", + "id": "getting-started" + }, + { + "name": "Resources", + "id": "resources" + }, + { + "name": "About", + "id": "about" + } + ] }, { - "name": "Building Full-Stack Applications", - "id": "build-full-stack-applications", - "path": "fundamentals/build-full-stack-applications" + "name": "Tutorial", + "id": "tutorial", + "itemList": [ + { + "name": "1 - Create Application", + "id": "01-create-application" + } + ] }, { - "name": "Developing Like Google", - "id": "develop-like-google", - "path": "fundamentals/develop-like-google" + "name": "Fundamentals", + "id": "fundamentals", + "itemList": [ + { + "name": "Using Modern Tools", + "id": "use-modern-tools" + }, + { + "name": "Building Full-Stack Applications", + "id": "build-full-stack-applications" + }, + { + "name": "Developing Like Google", + "id": "develop-like-google" + } + ] } ] }, + { - "name": "Guides", - "id": "guides", + "id": "r", "itemList": [ { - "name": "Using Cypress", - "id": "modernize-cypress", - "path": "guides/modernize-cypress" - }, - { - "name": "Using Jest", - "id": "modernize-jest", - "path": "guides/modernize-jest" - }, - { - "name": "Rebuilding and Retesting What is Affected", - "id": "monorepo-affected", - "path": "guides/monorepo-affected" - }, - { - "name": "Analysing & Visualizing Workspaces", - "id": "monorepo-dependency-diagrams", - "path": "guides/monorepo-dependency-diagrams" - }, - { - "name": "Imposing Constraints on the Dependency Graph", - "id": "monorepo-tags", - "path": "guides/monorepo-tags" - }, - { - "name": "Using React", - "id": "react", - "path": "guides/react" - }, - { - "name": "Building Angular and React Applications Together With Nx", - "id": "react-and-angular", - "path": "guides/react-and-angular" - }, - { - "name": "Setting Up NgRx", - "id": "misc-ngrx", - "path": "guides/misc-ngrx" - }, - { - "name": "Using DataPersistence", - "id": "misc-data-persistence", - "path": "guides/misc-data-persistence" - }, - { - "name": "Upgrading AngularJS Applications", - "id": "misc-upgrade", - "path": "guides/misc-upgrade" + "name": "Getting Started", + "id": "getting-started", + "itemList": [ + { + "name": "What is Nx?", + "id": "what-is-nx" + }, + { + "name": "Getting Started", + "id": "getting-started" + }, + { + "name": "Resources", + "id": "resources" + }, + { + "name": "About", + "id": "about" + } + ] }, { - "name": "Using Nx at Enterprises", - "id": "monorepo-nx-enterprise", - "path": "guides/monorepo-nx-enterprise" + "name": "Tutorial", + "id": "tutorial", + "itemList": [ + { + "name": "1 - Create Application", + "id": "01-create-application" + } + ] }, { - "name": "Changes between Nx 7 and Nx 8", - "id": "nx7-to-nx8", - "path": "guides/nx7-to-nx8" + "name": "Fundamentals", + "id": "fundamentals", + "itemList": [ + { + "name": "Using Modern Tools", + "id": "use-modern-tools" + }, + { + "name": "Building Full-Stack Applications", + "id": "build-full-stack-applications" + }, + { + "name": "Developing Like Google", + "id": "develop-like-google" + } + ] } ] } diff --git a/docs/r/fundamentals/build-full-stack-applications.md b/docs/r/fundamentals/build-full-stack-applications.md new file mode 100644 index 0000000000000..ebae4ea032790 --- /dev/null +++ b/docs/r/fundamentals/build-full-stack-applications.md @@ -0,0 +1,3 @@ +# React Build Full Stack Applications + +TODO diff --git a/docs/r/fundamentals/develop-like-google.md b/docs/r/fundamentals/develop-like-google.md new file mode 100644 index 0000000000000..0d11a1e57bc24 --- /dev/null +++ b/docs/r/fundamentals/develop-like-google.md @@ -0,0 +1,3 @@ +# React Develop Like Google + +TODO diff --git a/docs/r/fundamentals/use-modern-tools.md b/docs/r/fundamentals/use-modern-tools.md new file mode 100644 index 0000000000000..ad7f2a4516116 --- /dev/null +++ b/docs/r/fundamentals/use-modern-tools.md @@ -0,0 +1,3 @@ +# React Use Modern Tools + +TODO diff --git a/docs/r/getting-started/about.md b/docs/r/getting-started/about.md new file mode 100644 index 0000000000000..7012cc8b821fd --- /dev/null +++ b/docs/r/getting-started/about.md @@ -0,0 +1,43 @@ +# About Nx + +## How Nx Was Born + +After leaving Google and founding Nrwl, we were soon helping large organizations use Angular well. After doing this for some time, we’d discovered that many of them want to do the same things. + +- Integrate innovative tools into their dev workflows. +- Build their applications holistically, share code, and improve team collaboration. +- Adopt development practices pioneered at Google. + +And that’s how Nx was born. It was a distillation of our experience implementing these things over and over again. + +Building _a_ full-stack development toolkit is not hard, and neither is adopting Cypress into your development workflow. + +It is an entirely different story if your solution has to work in different companies, with unique tech stacks and development cultures. In the companies where one team may insist on using Protractor, whereas the rest of the company will use Cypress. Where there are so many teams working on so many related projects, that you have no choice but to rely on advanced code analysis and tools to keep the whole thing running. + +This is why Nx is awesome. It's not a toy implementation of a cool idea -- it's a toolkit for building applications using modern tools and development practices that scale. **Everything in Nx is validated by many real projects.** + +## Nx Today + +There is a misconception that large companies and startups have fundamentally different needs. It’s not true. + +These days even small products have several microservies and several frontends (say desktop and mobile) which are often built by distributed teams. Being able to do this type of development holistically, using modern tools, is as important for a startup as it is for a well-established organization. + +So even though the first users of Nx were Fortune 500 companies, these days we see more and more small companies using Nx to build their products. + +All our products at Nrwl, including Angular Console, and even this site, are built using Nx. + +## The Future of Nx + +A lot of Fortune 500 companies are building their client-facing flagship products using Nx. We are excited to see many of them contribute back to the toolkit. At Nrwl, we are helping many clients build ambitious projects, which gives us valuable feedback to keep making Nx better with every release. + +## Stay Updated On Nx + +Be sure to follow [the Nx github repository](https://github.com/nrwl/nx). Follow us on our [new twitter account](https://twitter.com/NXdevtools), so you get the latest news, and also follow Nrwl’s [Medium blog](https://blog.nrwl.io), where we post our news. + +## About Nrwl + +Nrwl is a software consultancy and the creator of the open-source developer toolkits, Nx and Angular Console, and a developer empowerment platform called Nrwl Connect. + +Nrwl designs intelligent technology systems and creates high-quality enterprise software by providing expert consulting, tooling, and Angular support from an unparalleled team of Angular experts. Enterprise teams come to Nrwl to standardize their development practices, achieve greater collaboration, and ultimately build better customer-facing products within a faster timeline. + +[Learn More](https://nrwl.io) diff --git a/docs/r/getting-started/getting-started.md b/docs/r/getting-started/getting-started.md new file mode 100644 index 0000000000000..6c0b5b2284a82 --- /dev/null +++ b/docs/r/getting-started/getting-started.md @@ -0,0 +1,3 @@ +# React Getting Started + +TODO diff --git a/docs/r/getting-started/resources.md b/docs/r/getting-started/resources.md new file mode 100644 index 0000000000000..1212db78636fa --- /dev/null +++ b/docs/r/getting-started/resources.md @@ -0,0 +1,3 @@ +# React Resources + +TODO diff --git a/docs/r/getting-started/what-is-nx.md b/docs/r/getting-started/what-is-nx.md new file mode 100644 index 0000000000000..ed4de85ed0e83 --- /dev/null +++ b/docs/r/getting-started/what-is-nx.md @@ -0,0 +1,3 @@ +# React What is Nx + +TODO diff --git a/docs/r/tutorial/01-create-application.md b/docs/r/tutorial/01-create-application.md new file mode 100644 index 0000000000000..e8d1218e127c5 --- /dev/null +++ b/docs/r/tutorial/01-create-application.md @@ -0,0 +1,3 @@ +# React Tutorial + +TODO diff --git a/docs/fundamentals/cypress-logo.png b/docs/shared/cypress-logo.png similarity index 100% rename from docs/fundamentals/cypress-logo.png rename to docs/shared/cypress-logo.png diff --git a/docs/fundamentals/jest-logo.png b/docs/shared/jest-logo.png similarity index 100% rename from docs/fundamentals/jest-logo.png rename to docs/shared/jest-logo.png diff --git a/docs/w/fundamentals/build-full-stack-applications.md b/docs/w/fundamentals/build-full-stack-applications.md new file mode 100644 index 0000000000000..c8e593e779e6b --- /dev/null +++ b/docs/w/fundamentals/build-full-stack-applications.md @@ -0,0 +1,3 @@ +# Web Components Build Full Stack Applications + +TODO diff --git a/docs/w/fundamentals/develop-like-google.md b/docs/w/fundamentals/develop-like-google.md new file mode 100644 index 0000000000000..adab5258d8e31 --- /dev/null +++ b/docs/w/fundamentals/develop-like-google.md @@ -0,0 +1,3 @@ +# Web Components Develop Like Google + +TODO diff --git a/docs/w/fundamentals/use-modern-tools.md b/docs/w/fundamentals/use-modern-tools.md new file mode 100644 index 0000000000000..358e51352b491 --- /dev/null +++ b/docs/w/fundamentals/use-modern-tools.md @@ -0,0 +1,3 @@ +# Web Components Use Modern Tools + +TODO diff --git a/docs/w/getting-started/about.md b/docs/w/getting-started/about.md new file mode 100644 index 0000000000000..7012cc8b821fd --- /dev/null +++ b/docs/w/getting-started/about.md @@ -0,0 +1,43 @@ +# About Nx + +## How Nx Was Born + +After leaving Google and founding Nrwl, we were soon helping large organizations use Angular well. After doing this for some time, we’d discovered that many of them want to do the same things. + +- Integrate innovative tools into their dev workflows. +- Build their applications holistically, share code, and improve team collaboration. +- Adopt development practices pioneered at Google. + +And that’s how Nx was born. It was a distillation of our experience implementing these things over and over again. + +Building _a_ full-stack development toolkit is not hard, and neither is adopting Cypress into your development workflow. + +It is an entirely different story if your solution has to work in different companies, with unique tech stacks and development cultures. In the companies where one team may insist on using Protractor, whereas the rest of the company will use Cypress. Where there are so many teams working on so many related projects, that you have no choice but to rely on advanced code analysis and tools to keep the whole thing running. + +This is why Nx is awesome. It's not a toy implementation of a cool idea -- it's a toolkit for building applications using modern tools and development practices that scale. **Everything in Nx is validated by many real projects.** + +## Nx Today + +There is a misconception that large companies and startups have fundamentally different needs. It’s not true. + +These days even small products have several microservies and several frontends (say desktop and mobile) which are often built by distributed teams. Being able to do this type of development holistically, using modern tools, is as important for a startup as it is for a well-established organization. + +So even though the first users of Nx were Fortune 500 companies, these days we see more and more small companies using Nx to build their products. + +All our products at Nrwl, including Angular Console, and even this site, are built using Nx. + +## The Future of Nx + +A lot of Fortune 500 companies are building their client-facing flagship products using Nx. We are excited to see many of them contribute back to the toolkit. At Nrwl, we are helping many clients build ambitious projects, which gives us valuable feedback to keep making Nx better with every release. + +## Stay Updated On Nx + +Be sure to follow [the Nx github repository](https://github.com/nrwl/nx). Follow us on our [new twitter account](https://twitter.com/NXdevtools), so you get the latest news, and also follow Nrwl’s [Medium blog](https://blog.nrwl.io), where we post our news. + +## About Nrwl + +Nrwl is a software consultancy and the creator of the open-source developer toolkits, Nx and Angular Console, and a developer empowerment platform called Nrwl Connect. + +Nrwl designs intelligent technology systems and creates high-quality enterprise software by providing expert consulting, tooling, and Angular support from an unparalleled team of Angular experts. Enterprise teams come to Nrwl to standardize their development practices, achieve greater collaboration, and ultimately build better customer-facing products within a faster timeline. + +[Learn More](https://nrwl.io) diff --git a/docs/w/getting-started/getting-started.md b/docs/w/getting-started/getting-started.md new file mode 100644 index 0000000000000..1495090bd2276 --- /dev/null +++ b/docs/w/getting-started/getting-started.md @@ -0,0 +1,3 @@ +# Web Components Getting Started + +TODO diff --git a/docs/w/getting-started/resources.md b/docs/w/getting-started/resources.md new file mode 100644 index 0000000000000..921af9541cae2 --- /dev/null +++ b/docs/w/getting-started/resources.md @@ -0,0 +1,3 @@ +# Web Components Resources + +TODO diff --git a/docs/w/getting-started/what-is-nx.md b/docs/w/getting-started/what-is-nx.md new file mode 100644 index 0000000000000..672b9bef43497 --- /dev/null +++ b/docs/w/getting-started/what-is-nx.md @@ -0,0 +1,3 @@ +# Web Components What is Nx + +TODO diff --git a/docs/w/tutorial/01-create-application.md b/docs/w/tutorial/01-create-application.md new file mode 100644 index 0000000000000..50231ee81a149 --- /dev/null +++ b/docs/w/tutorial/01-create-application.md @@ -0,0 +1,3 @@ +# Web Components Tutorial + +TODO diff --git a/scripts/documentation/documentation.sh b/scripts/documentation/documentation.sh index 7d69388b2d108..938333c3b3eae 100755 --- a/scripts/documentation/documentation.sh +++ b/scripts/documentation/documentation.sh @@ -2,7 +2,6 @@ echo "Generating API documentation" ts-node ./scripts/documentation/generate-builders-data.ts -ts-node ./scripts/documentation/generate-npmscripts-data.ts ts-node ./scripts/documentation/generate-schematics-data.ts ts-node ./scripts/documentation/generate-api-home.ts -#ts-node ./scripts/documentation/dependencies.ts +ts-node ./scripts/documentation/generate-npmscripts-data.ts diff --git a/scripts/documentation/generate-api-home.ts b/scripts/documentation/generate-api-home.ts index c011999ec917c..a910af72ddffa 100644 --- a/scripts/documentation/generate-api-home.ts +++ b/scripts/documentation/generate-api-home.ts @@ -15,28 +15,28 @@ can see, for each package its dependencies. const imagesTemplate = dedent` ## Angular -![Angular](./angular.jpg) +![Angular](/assets/content/api/angular.jpg) ## React -![React](./react.jpg) +![React](/assets/content/api/react.jpg) ## Nest -![Nest](./nest.jpg) +![Nest](/assets/content/api/nest.jpg) ## Express -![Express](./express.jpg) +![Express](/assets/content/api/express.jpg) ## Node -![Node](./node.jpg) +![Node](/assets/content/api/node.jpg) ## Cypress -![Cypress](./cypress.jpg) +![Cypress](/assets/content/api/cypress.jpg) ## Jest -![Jest](./jest.jpg) +![Jest](/assets/content/api/jest.jpg) ## Web -![Web](./web.jpg) +![Web](/assets/content/api/web.jpg) `; getPackageConfigurations() diff --git a/scripts/documentation/generate-npmscripts-data.ts b/scripts/documentation/generate-npmscripts-data.ts index 8f61b12916878..dffc19c3a3bbe 100644 --- a/scripts/documentation/generate-npmscripts-data.ts +++ b/scripts/documentation/generate-npmscripts-data.ts @@ -8,7 +8,7 @@ import { commandsObject } from '../../packages/workspace'; const commandsOutputDirectory = path.join( __dirname, - '../../docs/api-npmscripts' + '../../docs/api-workspace/npmscripts' ); fs.removeSync(commandsOutputDirectory); function getCommands(command) {