Expand doc for initial cmds#12597
Conversation
jbogarthyde
added
area: docs
jenniferfell
left a comment
jenniferfell
left a comment
There was a problem hiding this comment.
Looks good. Thanks for the quick PR. Only one essential change, adding a note about prompts to ng new. Other things are minor ideas open to interpretation. Thanks!
| "$id": "ng-cli://commands/new.json", | ||
| "description": "Creates a new directory and a new Angular app.", | ||
| "$longDescription": "", | ||
| "description": "Creates a new workspace and a new default Angular app.", |
There was a problem hiding this comment.
Let's not use default to mean "initial" or "starter". Thx.
| @@ -0,0 +1,5 @@ | |||
| Creates and initializes a new Angular app that is the default project for a new workspace. | |||
| @@ -0,0 +1,5 @@ | |||
| Creates and initializes a new Angular app that is the default project for a new workspace. | |||
|
|
|||
| * The new workspace folder is given the specified project name. The new app is created at the top level of the workspace folder. | |||
There was a problem hiding this comment.
The new app is in the src folder. That's where all the app-specific source code and configuration files live.
| @@ -0,0 +1 @@ | |||
| Before running this command, see the interactive [Angular Update Guide](https://update.angular.io/). No newline at end of file | |||
| "$id": "ng-cli://commands/update.json", | ||
| "description": "Updates your application and its dependencies.", | ||
| "$longDescription": "", | ||
| "description": "Updates your application and its dependencies. See \"https://update.angular.io/\", |
| @@ -1,2 +1,3 @@ | |||
| Add support for a library in your project, for example adding `@angular/pwa` which would configure | |||
| your project for PWA support. | |||
| Adds the npm package for a published library to your workspace, and configures your default | |||
There was a problem hiding this comment.
Tech question: Configures the app set in "defaultProject" or configures the current app project (when executed from within an app project folder)?
There was a problem hiding this comment.
I don't think there is any "current app project" here - it doesn't take a "project" arg, just the package name. I added a note about "defaultProject".
|
|
||
| * The new workspace folder is given the specified project name. The new app is created at the top level of the workspace folder. | ||
|
|
||
| * The new app's configuration appears in the `projects` section of the `angular.json` workspace configuration file, under its project name. No newline at end of file |
There was a problem hiding this comment.
Please add a note somewhere about prompts. Something like this: The command prompts for information about features to include in the initial app project, such as routing and the CSS file to use.
There was a problem hiding this comment.
Actually I added this before, but messed up the PR and had to start over and recreate the text. Adding it back now.
| "$id": "ng-cli://commands/update.json", | ||
| "description": "Updates your application and its dependencies.", | ||
| "$longDescription": "", | ||
| "description": "Updates your application and its dependencies. See \"https://update.angular.io/\", |
There was a problem hiding this comment.
Heya, this line contains invalid JSON and is breaking the CI.
jbogarthyde
force-pushed
the
jb-cmds-edit
branch
from
8765733 to
cf035c1
Compare
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
alexeagle
force-pushed
the
jb-cmds-edit
branch
from
d9ac2ff to
3ac0823
Compare
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
5 participants
Add long descriptions and references for the "add", "new" and "update" commands