From ea2cfbbd2ef32cefb32acc75b7e09f92d3d6b63b Mon Sep 17 00:00:00 2001 From: Vani Date: Wed, 10 Oct 2018 14:28:49 -0700 Subject: [PATCH] docs: remove setup for local dev and anatomy of setup docs from nav (#26380) PR Close #26380 --- aio/content/guide/setup-systemjs-anatomy.md | 360 -------------------- aio/content/guide/setup.md | 2 +- aio/content/navigation.json | 33 +- aio/firebase.json | 1 + aio/ngsw-config.json | 2 + 5 files changed, 25 insertions(+), 373 deletions(-) delete mode 100644 aio/content/guide/setup-systemjs-anatomy.md diff --git a/aio/content/guide/setup-systemjs-anatomy.md b/aio/content/guide/setup-systemjs-anatomy.md deleted file mode 100644 index 0cf2aa63dd..0000000000 --- a/aio/content/guide/setup-systemjs-anatomy.md +++ /dev/null @@ -1,360 +0,0 @@ -# Anatomy of the Setup Project - -The documentation [setup](guide/setup) procedures install a _lot_ of files. -Most of them can be safely ignored. - -Application files _inside the_ **`src/`** and **`e2e/`** folders matter most to developers. - -Files _outside_ those folders condition the development environment. -They rarely change and you may never view or modify them. -If you do, this page can help you understand their purpose. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- File - - Purpose -
- src/app/ - - - - Angular application files go here. - - Ships with the "Hello Angular" sample's - `AppComponent`, `AppModule`, a component unit test (`app.component.spec.ts`), and - the bootstrap file, `main.ts`. - - Try the sample application - and the unit test - as _live examples_. -
- e2e/ - - - - _End-to-end_ (e2e) tests of the application, - written in Jasmine and run by the - protractor - e2e test runner. - - Initialized with an e2e test for the "Hello Angular" sample. -
- node_modules/ - - - - The _npm_ packages installed with the `npm install` command. -
- .editorconfig
-.git/
-.gitignore
-.travis.yml - 		- - - Tooling configuration files and folders. - Ignore them until you have a compelling reason to do otherwise. -
- CHANGELOG.md - - - - The history of changes to the _QuickStart_ repository. - Delete or ignore. -
- favicon.ico - - - - The application icon that appears in the browser tab. -
- index.html - - - - The application host page. - It loads a few essential scripts in a prescribed order. - Then it boots the application, placing the root `AppComponent` - in the custom `` body tag. - - The same `index.html` satisfies all documentation application samples. -
- karma.conf.js - - - - Configuration for the karma - test runner described in the [Testing](guide/testing) guide. -
- karma-test-shim.js - - - - Script to run karma - with SystemJS as described in the [Testing](guide/testing) guide. -
- non-essential-files.txt - - - - A list of files that you can delete if you want to purge your setup of the - original QuickStart Seed testing and git maintenance artifacts. - See instructions in the optional - [_Deleting non-essential files_](guide/setup#non-essential "Setup: Deleting non-essential files") section. - *Do this only in the beginning to avoid accidentally deleting your own tests and git setup!* -
- LICENSE - - - - The open source MIT license to use this setup code in your application. -
- package.json - - - - Identifies `npm `package dependencies for the project. - - Contains command scripts for running the application, - running tests, and more. Enter `npm run` for a listing. - Read more about them. -
- protractor.config.js - - - - Configuration for the - protractor - _end-to-end_ (e2e) test runner. -
- README.md - - - - Instruction for using this git repository in your project. - Worth reading before deleting. -
- styles.css - - - - Global styles for the application. Initialized with an `

` style for the QuickStart demo. - -

- systemjs
.config.js - 		- - - Tells the **SystemJS** module loader where to find modules - referenced in JavaScript `import` statements. For example: - - import { Component } from '@angular/core; - - - - Don't touch this file unless you are fully versed in SystemJS configuration. -
- systemjs
.config.extras.js - 		- - - Optional extra SystemJS configuration. - A way to add SystemJS mappings, such as for application _barrels_, - without changing the original `system.config.js`. -
- tsconfig.json - - - - Tells the TypeScript compiler how to transpile TypeScript source files - into JavaScript files that run in all modern browsers. -
- tslint.json - - - - The `npm` installed TypeScript linter inspects your TypeScript code - and complains when you violate one of its rules. - - This file defines linting rules favored by the - [Angular style guide](guide/styleguide) and by the authors of the documentation. -
- diff --git a/aio/content/guide/setup.md b/aio/content/guide/setup.md index 5898c6dfa0..71d52d43b4 100644 --- a/aio/content/guide/setup.md +++ b/aio/content/guide/setup.md @@ -125,7 +125,7 @@ Open a terminal window in the project folder and enter the following commands fo The **QuickStart seed** contains the same application as the QuickStart playground. But its true purpose is to provide a solid foundation for _local_ development. Consequently, there are _many more files_ in the project folder on your machine, -most of which you can [learn about later](guide/setup-systemjs-anatomy "Setup Anatomy"). +most of which you can [learn about later](guide/file-structure). diff --git a/aio/content/navigation.json b/aio/content/navigation.json index 0266673c4b..2da201e319 100644 --- a/aio/content/navigation.json +++ b/aio/content/navigation.json @@ -473,7 +473,7 @@ "url": "guide/universal", "title": "Server-side Rendering", "tooltip": "Render HTML server-side with Angular Universal." - }, + }, { "title": "Upgrading from AngularJS", "tooltip": "Incrementally upgrade an AngularJS application to Angular.", @@ -509,7 +509,7 @@ "tooltip": "Install the Angular QuickStart seed for faster, more efficient development on your machine.", "hidden": true }, - + { "url": "guide/file-structure", "title": "Project File Structure", @@ -524,7 +524,7 @@ "url": "guide/typescript-configuration", "title": "TypeScript Configuration", "tooltip": "TypeScript configuration for Angular developers." - }, + }, { "url": "guide/aot-compiler", "title": "Ahead-of-Time Compilation", @@ -544,14 +544,14 @@ "url": "guide/deployment", "title": "Deployment", "tooltip": "Learn how to deploy your Angular app." - }, + }, { "url": "guide/browser-support", "title": "Browser Support", "tooltip": "Browser support and polyfills guide." }, - { + { "title": "Dev Tool Integration", "tooltip": "Integrate with your development environment and tools.", "children": [ @@ -567,13 +567,6 @@ "hidden": true } ] - }, - - { - "url": "guide/setup-systemjs-anatomy", - "title": "Anatomy of the Setup", - "tooltip": "Inside the local development environment for SystemJS.", - "hidden": true } ] }, @@ -592,6 +585,22 @@ "url": "guide/updating", "title": "Keeping Up-to-Date", "tooltip": "Information about updating Angular applications and libraries to the latest version." + }, + { + "title": "Upgrading from AngularJS", + "tooltip": "Incrementally upgrade an AngularJS application to Angular.", + "children": [ + { + "url": "guide/upgrade", + "title": "Upgrading Instructions", + "tooltip": "Incrementally upgrade an AngularJS application to Angular." + }, + { + "url": "guide/ajs-quick-reference", + "title": "AngularJS-Angular Concepts", + "tooltip": "Learn how AngularJS concepts and techniques map to Angular." + } + ] } ] }, diff --git a/aio/firebase.json b/aio/firebase.json index 5700ee5f5f..9699fa2b1a 100644 --- a/aio/firebase.json +++ b/aio/firebase.json @@ -26,6 +26,7 @@ {"type": 301, "source": "/guide/service-worker-comm", "destination": "/guide/service-worker-communications"}, {"type": 301, "source": "/guide/service-worker-configref", "destination": "/guide/service-worker-config"}, {"type": 301, "source": "/guide/webpack", "destination": "https://v5.angular.io/guide/webpack"}, + {"type": 301, "source": "/guide/setup-systemjs-anatomy", "destination": "/guide/file-structure"}, // some top level guide pages on old site were moved below the guide folder {"type": 301, "source": "/styleguide", "destination": "/guide/styleguide"}, diff --git a/aio/ngsw-config.json b/aio/ngsw-config.json index f005b6b4b9..8472b21b21 100644 --- a/aio/ngsw-config.json +++ b/aio/ngsw-config.json @@ -117,6 +117,8 @@ "!/guide/webpack", "!/guide/webpack.html", "!/guide/webpack/", + "!/guide/setup-systemjs-anatomy", + "!/guide/setup-systemjs-anatomy.html", "!/news", "!/news.html", "!/news/",