feat(docs): scope docs

nrwl · Jun 19, 2019 · 5b4127e · 5b4127e
1 parent 9e15f4a
commit 5b4127e
Show file tree

Hide file tree

Showing 89 changed files with 408 additions and 196 deletions.
diff --git a/...amentals/build-full-stack-applications.md → ...amentals/build-full-stack-applications.md b/...amentals/build-full-stack-applications.md → ...amentals/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 → docs/a/fundamentals/develop-like-google.md b/docs/fundamentals/develop-like-google.md → 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,15 +256,15 @@ 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
 
 In addition to implementing monorepo-style of development, Nx brings in another key element of Google dev culture--emphasis on tooling.
 
 ### 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 → docs/a/fundamentals/full-stack-app.png b/docs/fundamentals/full-stack-app.png → docs/a/fundamentals/full-stack-app.png
diff --git a/docs/fundamentals/full-stack-deps.png → docs/a/fundamentals/full-stack-deps.png b/docs/fundamentals/full-stack-deps.png → docs/a/fundamentals/full-stack-deps.png
diff --git a/docs/fundamentals/lint-error.png → docs/a/fundamentals/lint-error.png b/docs/fundamentals/lint-error.png → docs/a/fundamentals/lint-error.png
diff --git a/...undamentals/monorepo-diagram-affected.png → ...undamentals/monorepo-diagram-affected.png b/...undamentals/monorepo-diagram-affected.png → ...undamentals/monorepo-diagram-affected.png
diff --git a/docs/fundamentals/monorepo-diagram.png → docs/a/fundamentals/monorepo-diagram.png b/docs/fundamentals/monorepo-diagram.png → docs/a/fundamentals/monorepo-diagram.png
diff --git a/docs/fundamentals/nest-logo.png → docs/a/fundamentals/nest-logo.png b/docs/fundamentals/nest-logo.png → docs/a/fundamentals/nest-logo.png
diff --git a/docs/fundamentals/prettier-logo.png → docs/a/fundamentals/prettier-logo.png b/docs/fundamentals/prettier-logo.png → docs/a/fundamentals/prettier-logo.png
diff --git a/docs/fundamentals/use-modern-tools.md → docs/a/fundamentals/use-modern-tools.md b/docs/fundamentals/use-modern-tools.md → 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 → docs/a/getting-started/about.md b/docs/getting-started/about.md → docs/a/getting-started/about.md
diff --git a/docs/getting-started/create-workspace.gif → docs/a/getting-started/create-workspace.gif b/docs/getting-started/create-workspace.gif → docs/a/getting-started/create-workspace.gif
diff --git a/docs/getting-started/dep-graph.png → docs/a/getting-started/dep-graph.png b/docs/getting-started/dep-graph.png → docs/a/getting-started/dep-graph.png
diff --git a/docs/getting-started/getting-started.md → docs/a/getting-started/getting-started.md b/docs/getting-started/getting-started.md → docs/a/getting-started/getting-started.md
diff --git a/docs/getting-started/lint-error.png → docs/a/getting-started/lint-error.png b/docs/getting-started/lint-error.png → docs/a/getting-started/lint-error.png
diff --git a/docs/getting-started/nx-and-cli.md → docs/a/getting-started/nx-and-cli.md b/docs/getting-started/nx-and-cli.md → 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 → docs/a/getting-started/resources.md b/docs/getting-started/resources.md → docs/a/getting-started/resources.md
diff --git a/docs/getting-started/what-is-nx.md → docs/a/getting-started/what-is-nx.md b/docs/getting-started/what-is-nx.md → 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 → docs/a/guides/affected.png b/docs/guides/affected.png → docs/a/guides/affected.png
diff --git a/docs/guides/dependency-graph.png → docs/a/guides/dependency-graph.png b/docs/guides/dependency-graph.png → docs/a/guides/dependency-graph.png
diff --git a/docs/guides/misc-data-persistence.md → docs/a/guides/misc-data-persistence.md b/docs/guides/misc-data-persistence.md → docs/a/guides/misc-data-persistence.md
diff --git a/docs/guides/misc-ngrx.md → docs/a/guides/misc-ngrx.md b/docs/guides/misc-ngrx.md → docs/a/guides/misc-ngrx.md
diff --git a/docs/guides/misc-upgrade.md → docs/a/guides/misc-upgrade.md b/docs/guides/misc-upgrade.md → docs/a/guides/misc-upgrade.md
diff --git a/docs/guides/modernize-cypress.md → docs/a/guides/modernize-cypress.md b/docs/guides/modernize-cypress.md → 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 → docs/a/guides/modernize-jest.md b/docs/guides/modernize-jest.md → 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 → docs/a/guides/modernize-prettier.md b/docs/guides/modernize-prettier.md → docs/a/guides/modernize-prettier.md
diff --git a/docs/guides/monorepo-affected.md → docs/a/guides/monorepo-affected.md b/docs/guides/monorepo-affected.md → docs/a/guides/monorepo-affected.md
diff --git a/docs/guides/monorepo-dependency-diagrams.md → .../a/guides/monorepo-dependency-diagrams.md b/docs/guides/monorepo-dependency-diagrams.md → .../a/guides/monorepo-dependency-diagrams.md
diff --git a/docs/guides/monorepo-nx-enterprise.md → docs/a/guides/monorepo-nx-enterprise.md b/docs/guides/monorepo-nx-enterprise.md → docs/a/guides/monorepo-nx-enterprise.md
diff --git a/docs/guides/monorepo-tags.md → docs/a/guides/monorepo-tags.md b/docs/guides/monorepo-tags.md → 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 → docs/a/guides/nx7-to-nx8.md b/docs/guides/nx7-to-nx8.md → 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 → docs/a/guides/react-affected.png b/docs/guides/react-affected.png → docs/a/guides/react-affected.png
diff --git a/docs/guides/react-affected2.png → docs/a/guides/react-affected2.png b/docs/guides/react-affected2.png → docs/a/guides/react-affected2.png
diff --git a/docs/guides/react-and-angular.md → docs/a/guides/react-and-angular.md b/docs/guides/react-and-angular.md → docs/a/guides/react-and-angular.md
diff --git a/docs/guides/react-dep-graph.png → docs/a/guides/react-dep-graph.png b/docs/guides/react-dep-graph.png → docs/a/guides/react-dep-graph.png
diff --git a/docs/guides/react-serve.png → docs/a/guides/react-serve.png b/docs/guides/react-serve.png → docs/a/guides/react-serve.png
diff --git a/docs/guides/react.md → docs/a/guides/react.md b/docs/guides/react.md → docs/a/guides/react.md
diff --git a/docs/guides/tools-workspace-schematics.md → docs/a/guides/tools-workspace-schematics.md b/docs/guides/tools-workspace-schematics.md → docs/a/guides/tools-workspace-schematics.md
diff --git a/docs/tutorial/01-create-application.md → docs/a/tutorial/01-create-application.md b/docs/tutorial/01-create-application.md → docs/a/tutorial/01-create-application.md
diff --git a/docs/tutorial/02-add-e2e-test.md → docs/a/tutorial/02-add-e2e-test.md b/docs/tutorial/02-add-e2e-test.md → docs/a/tutorial/02-add-e2e-test.md
diff --git a/docs/tutorial/03-display-todos.md → docs/a/tutorial/03-display-todos.md b/docs/tutorial/03-display-todos.md → docs/a/tutorial/03-display-todos.md
diff --git a/docs/tutorial/04-connect-to-api.md → docs/a/tutorial/04-connect-to-api.md b/docs/tutorial/04-connect-to-api.md → docs/a/tutorial/04-connect-to-api.md
diff --git a/docs/tutorial/05-add-node-app.md → docs/a/tutorial/05-add-node-app.md b/docs/tutorial/05-add-node-app.md → docs/a/tutorial/05-add-node-app.md
diff --git a/docs/tutorial/06-proxy.md → docs/a/tutorial/06-proxy.md b/docs/tutorial/06-proxy.md → docs/a/tutorial/06-proxy.md
diff --git a/docs/tutorial/07-share-code.md → docs/a/tutorial/07-share-code.md b/docs/tutorial/07-share-code.md → docs/a/tutorial/07-share-code.md
diff --git a/docs/tutorial/08-create-libs.md → docs/a/tutorial/08-create-libs.md b/docs/tutorial/08-create-libs.md → docs/a/tutorial/08-create-libs.md
diff --git a/docs/tutorial/09-dep-graph.md → docs/a/tutorial/09-dep-graph.md b/docs/tutorial/09-dep-graph.md → docs/a/tutorial/09-dep-graph.md
diff --git a/docs/tutorial/10-test-affected-projects.md → docs/a/tutorial/10-test-affected-projects.md b/docs/tutorial/10-test-affected-projects.md → docs/a/tutorial/10-test-affected-projects.md
diff --git a/docs/tutorial/11-build-affected-projects.md → .../a/tutorial/11-build-affected-projects.md b/docs/tutorial/11-build-affected-projects.md → .../a/tutorial/11-build-affected-projects.md
diff --git a/docs/tutorial/12-summary.md → docs/a/tutorial/12-summary.md b/docs/tutorial/12-summary.md → 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 → ...api-workspace/npmscripts/affected-apps.md b/docs/api-npmscripts/affected-apps.md → ...api-workspace/npmscripts/affected-apps.md
diff --git a/docs/api-npmscripts/affected-build.md → ...pi-workspace/npmscripts/affected-build.md b/docs/api-npmscripts/affected-build.md → ...pi-workspace/npmscripts/affected-build.md
diff --git a/docs/api-npmscripts/affected-dep-graph.md → ...orkspace/npmscripts/affected-dep-graph.md b/docs/api-npmscripts/affected-dep-graph.md → ...orkspace/npmscripts/affected-dep-graph.md
diff --git a/docs/api-npmscripts/affected-e2e.md → .../api-workspace/npmscripts/affected-e2e.md b/docs/api-npmscripts/affected-e2e.md → .../api-workspace/npmscripts/affected-e2e.md
diff --git a/docs/api-npmscripts/affected-libs.md → ...api-workspace/npmscripts/affected-libs.md b/docs/api-npmscripts/affected-libs.md → ...api-workspace/npmscripts/affected-libs.md
diff --git a/docs/api-npmscripts/affected-lint.md → ...api-workspace/npmscripts/affected-lint.md b/docs/api-npmscripts/affected-lint.md → ...api-workspace/npmscripts/affected-lint.md
diff --git a/docs/api-npmscripts/affected-test.md → ...api-workspace/npmscripts/affected-test.md b/docs/api-npmscripts/affected-test.md → ...api-workspace/npmscripts/affected-test.md
diff --git a/docs/api-npmscripts/affected.md → docs/api-workspace/npmscripts/affected.md b/docs/api-npmscripts/affected.md → docs/api-workspace/npmscripts/affected.md
diff --git a/docs/api-npmscripts/dep-graph.md → docs/api-workspace/npmscripts/dep-graph.md b/docs/api-npmscripts/dep-graph.md → docs/api-workspace/npmscripts/dep-graph.md
diff --git a/docs/api-npmscripts/format-check.md → .../api-workspace/npmscripts/format-check.md b/docs/api-npmscripts/format-check.md → .../api-workspace/npmscripts/format-check.md
diff --git a/docs/api-npmscripts/format-write.md → .../api-workspace/npmscripts/format-write.md b/docs/api-npmscripts/format-write.md → .../api-workspace/npmscripts/format-write.md
diff --git a/docs/api-npmscripts/lint-files.md → docs/api-workspace/npmscripts/lint-files.md b/docs/api-npmscripts/lint-files.md → docs/api-workspace/npmscripts/lint-files.md
diff --git a/docs/api-npmscripts/update-check.md → .../api-workspace/npmscripts/update-check.md b/docs/api-npmscripts/update-check.md → .../api-workspace/npmscripts/update-check.md
diff --git a/docs/api-npmscripts/update-skip.md → docs/api-workspace/npmscripts/update-skip.md b/docs/api-npmscripts/update-skip.md → docs/api-workspace/npmscripts/update-skip.md
diff --git a/docs/api-npmscripts/update.md → docs/api-workspace/npmscripts/update.md b/docs/api-npmscripts/update.md → docs/api-workspace/npmscripts/update.md
diff --git a/...pi-npmscripts/workspace-schematic-name.md → ...ce/npmscripts/workspace-schematic-name.md b/...pi-npmscripts/workspace-schematic-name.md → ...ce/npmscripts/workspace-schematic-name.md
diff --git 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)