docs: minor updates to command reference

Don't mention Architect
We don't inline resources anymore
Minor grammar tweaks
Split out a couple more long descriptions so the short description is plain text
This commit is contained in:
Alex Eagle 2018-10-16 09:04:19 -07:00 committed by Alex Eagle
parent 3ad551c2ff
commit 21956ca25f
12 changed files with 28 additions and 15 deletions

View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/add.json",
"description": "Adds support for a published library to your project.",
"description": "Adds support for an external library to your project.",
"$longDescription": "./add.md",
"$scope": "in",

View File

@ -1,5 +1,3 @@
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root
of the output folder. If a resource is less than 10kb, it is also included inline.
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.
Uses the Webpack build tool, with environment and build options specified in the CLI configuration
file.
Uses the Webpack build tool, with environment and build options specified in the CLI configuration file.

View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/e2e.json",
"description": "Builds and serves an Angular app, and runs end-to-end tests using Protractor.",
"description": "Builds and serves an Angular app, then runs end-to-end tests using Protractor.",
"$longDescription": "./e2e-long.md",
"$aliases": [ "e" ],

View File

@ -0,0 +1,8 @@
The 'eject' command has been disabled and will be removed completely in 8.0.
The new configuration format provides increased flexibility to modify the
configuration of your workspace without ejecting.
There are several projects that can be used in conjuction with the new
configuration format that provide the benefits of ejecting without the maintenance
overhead. One such project is ngx-build-plus found here:
https://github.com/manfredsteyer/ngx-build-plus

View File

@ -1,8 +1,8 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/eject.json",
"description": "Temporarily disabled. Ejects your app and output the proper webpack configuration and scripts.",
"$longDescription": "",
"description": "Deprecated, will be removed in Angular 8.0.",
"$longDescription": "./eject-long.md",
"$hidden": true,
"$scope": "in",

View File

@ -0,0 +1,7 @@
For help with individual commands, use the `--help` or `-h` option with the command.
For example,
```sh
ng help serve
```

View File

@ -1,8 +1,8 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/help.json",
"description": "Lists available commands and their short descriptions in the console. \n &nbsp &nbsp For help with individual commands, use the \"--help\" or \"-h\" option with the command.",
"$longDescription": "",
"description": "Lists available commands and their short descriptions.",
"$longDescription": "./help-long.md",
"$scope": "all",
"$aliases": [],

View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/lint.json",
"description": "Runs the TSLint tool on Angular app code in the given project folder.",
"description": "Runs linting tools on Angular app code in a given project folder.",
"$longDescription": "./lint-long.md",
"$aliases": [ "l" ],

View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/run.json",
"description": "Runs Architect targets.",
"description": "Runs a custom target defined in your project.",
"$longDescription": "",
"$aliases": [],

View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/test.json",
"description": "Run unit tests in existing project.",
"description": "Runs unit tests in a project.",
"$longDescription": "",
"$aliases": [ "t" ],

View File

@ -1,8 +1,8 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/update.json",
"description": "Updates your application and its dependencies. See \"https://update.angular.io/\"",
"$longDescription": "./update.md",
"description": "Updates your application and its dependencies. See https://update.angular.io/",
"$longDescription": "./update-long.md",
"$scope": "all",
"$aliases": [],