Skip to content
This repository has been archived by the owner on Jun 22, 2023. It is now read-only.

Commit

Permalink
Update CLI reference docs (#192)
Browse files Browse the repository at this point in the history
* Update CLI reference docs

* Update install description to address feedback.

* Update index.html
  • Loading branch information
blackbaud-johnly authored Jan 10, 2019
1 parent be230d4 commit c7231fb
Show file tree
Hide file tree
Showing 10 changed files with 29 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/app/learn/get-started/basics/create-project/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
</li>
<li>
<p>
In the first prompt, specify a root directory for the application. The SKY UX CLI creates a folder with this name and prefixes it with "skyux-spa." The root directory also determines how to access the SPA because the URL for the home page includes the root directory after the base URL.
In the first prompt, specify a root directory for the application. The SKY UX CLI creates a folder with this name and prefixes it with "skyux-spa." The root directory determines how to access the SPA because the URL for the home page includes the root directory after the base URL.
</p>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion src/app/learn/reference/cli-commands/build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
<li><stache-include fileName="cli/envid.html"></stache-include></li>
<li><stache-include fileName="cli/launch.html"></stache-include></li>
<li><stache-include fileName="cli/logColor.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/logFormat.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/output-keep-alive.html"></stache-include></li>
<li><stache-include fileName="cli/serve.html"></stache-include></li>
<li><stache-include fileName="cli/svcid.html"></stache-include></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ export class CLICommandsActionButtonsComponent {
// tslint:disable-next-line
summary: 'Displays help for SKY UX CLI arguments.'
},
{
name: 'install',
path: '/learn/reference/cli-commands/install',
icon: 'wrench',
// tslint:disable-next-line
summary: 'Deletes and re-installs SKY UX dependencies.'
},
{
name: 'lint',
path: '/learn/reference/cli-commands/lint',
Expand Down
2 changes: 1 addition & 1 deletion src/app/learn/reference/cli-commands/e2e/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

<ul>
<li><stache-include fileName="cli/logColor.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/logFormat.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/no-build.html"></stache-include></li>
</ul>

Expand Down
8 changes: 8 additions & 0 deletions src/app/learn/reference/cli-commands/install/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<stache
pageTitle="install">

<p>
<stache-code>skyux install</stache-code> deletes the <stache-code>node_modules</stache-code> folder and runs <stache-code>npm install</stache-code>. This clears the existing dependencies in the <stache-code>node_modules</stache-code> folder and ensures that all SKY UX dependencies are consistent with your <stache-code>package.json</stache-code> file.
</p>

</stache>
5 changes: 5 additions & 0 deletions src/app/learn/reference/cli-commands/new/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
</stache-page-anchor>

<ul>
<li><stache-include fileName="cli/logColor.html"></stache-include></li>
<li><stache-include fileName="cli/logFormat.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/name.html"></stache-include></li>
<li><stache-include fileName="cli/repo.html"></stache-include></li>
<li><stache-include fileName="cli/template.html"></stache-include></li>
</ul>

Expand Down
2 changes: 1 addition & 1 deletion src/app/learn/reference/cli-commands/serve/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
<li><stache-include fileName="cli/launch.html"></stache-include></li>
<li><stache-include fileName="cli/leid.html"></stache-include></li>
<li><stache-include fileName="cli/logColor.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/logFormat.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/svcid.html"></stache-include></li>
</ul>

Expand Down
2 changes: 1 addition & 1 deletion src/app/learn/reference/cli-commands/test/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@

<ul>
<li><stache-include fileName="cli/logColor.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
<li><stache-include fileName="cli/logFormat.html"></stache-include></li>
<li><stache-include fileName="cli/logLevel.html"></stache-include></li>
</ul>

</stache>
1 change: 1 addition & 0 deletions src/stache/includes/cli/name.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<stache-code>--name</stache-code> — Specifies a root directory for the application. The SKY UX CLI creates a folder with this name and prefixes it with "skyux-spa." The root directory determines how to access the SPA because the URL for the home page includes the root directory after the base URL.
3 changes: 3 additions & 0 deletions src/stache/includes/cli/repo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<stache-code>--repo</stache-code> — Specifies the URL for a Git repo to store the source files for the application. You can use a Visual Studio Team System Git repo or a GitHub repo. The SKY UX CLI clones the repo and automatically pulls in the SKY UX template. To work locally only, you can create the SPA without a repo. Later, you can manually add a repo as a remote to the local application. To do this, enter <stache-code>git remote add origin [URL]</stache-code> in the command prompt, where "[URL]" is the path for the repo. Then to push local content to the external repo, enter <stache-code>git push origin --all</stache-code>.


0 comments on commit c7231fb

Please sign in to comment.