Add deploy command doc #15402
Add deploy command doc #15402
Conversation
jbogarthyde
added
effort1: easy (hours)
P5
|
|
||
| When a project name is not supplied, the CLI will execute the `deploy` builder for the default project. | ||
| The deploy builder defined in a deployment platform package is automatically added to a project's configuration when you add the package to the project. |
There was a problem hiding this comment.
Can we update it to something like:
To use the ng deploy command ng add a package that implements deployment capabilities to your favorite platform. The ng-add schematics of the package will automatically update your workspace configuration, adding a deployment CLI builder.
There was a problem hiding this comment.
Also adding link to CLI Builder guide.
| ``` | ||
| To use the `ng deploy` command, use `ng add` to add a package that implements deployment capabilities to your favorite platform. | ||
| Adding the package automatically updates your workspace configuration, adding a deployment | ||
| `CLI builder`(guide/cli-builder). |
There was a problem hiding this comment.
Users see deploy-long.md when the run ng deploy --help as well and this won't be rendered properly. Maybe we can drop it?
| `CLI builder`(guide/cli-builder). | |
| `CLI builder`. |
There was a problem hiding this comment.
OK -- but I think the long description only shows up in AIO, not in the help.
There was a problem hiding this comment.
Yep, feel free to ignore my comment.
|
@kyliau the failure is because the CLI's size increased with the doc change. |
* docs: add deploy command doc * docs: fix json example * docs: add link to cli builder doc * docs: remove link * docs: restore link
|
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. |
Adding some more detail to the API doc for the new
ng deploycommand.