Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): GitHub Deployment Docs out of date #1196

Merged
merged 1 commit into from
Jul 15, 2018
Merged

fix(docs): GitHub Deployment Docs out of date #1196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 2 additions & 33 deletions src/app/components/docs/deployment/deployment.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,8 @@
<mat-card>
<mat-card-title>Deployment</mat-card-title>
<mat-card-subtitle>Deploy your app via CLI</mat-card-subtitle>
<mat-card-title>Building</mat-card-title>
<mat-card-subtitle>Build your app via CLI</mat-card-subtitle>
<mat-divider></mat-divider>
<mat-card-content>
<h3>Command Line Deploy Tasks</h3>
<p>You can deploy your apps quickly via:</p>
<td-highlight lang="html">
ng github-pages:deploy --message "Optional commit message"
</td-highlight>

<p>This will do the following:</p>

<ul>
<li>creates GitHub repo for the current project if one doesn't exist</li>
<li>rebuilds the app in production mode at the current <code>HEAD</code></li>
<li>creates a local <code>gh-pages</code> branch if one doesn't exist</li>
<li>moves your app to the <code>gh-pages</code> branch and creates a commit</li>
<li>edit the base tag in index.html to support github pages</li>
<li>pushes the <code>gh-pages</code> branch to github</li>
<li>returns back to the original <code>HEAD</code></li>
</ul>

<p>Creating the repo requires a token from github, and the remaining functionality
relies on ssh authentication for all git operations that communicate with github.com.
To simplify the authentication, be sure to <a target="_blank" href="https://help.github.com/articles/generating-ssh-keys/">setup your ssh keys</a>.</p>

<p>If you are deploying a <a target="_blank" href="https://help.github.com/articles/user-organization-and-project-pages/">user or organization page</a>, you can instead use the following command:</p>

<td-highlight lang="html">
ng github-pages:deploy --user-page --message "Optional commit message"
</td-highlight>

<p>This command pushes the app to the <code>master</code> branch on the github repo instead
of pushing to <code>gh-pages</code>, since user and organization pages require this.</p>

<h3>Creating a build</h3>
<p>The build artifacts will be stored in the dist/ directory.</p>
<td-highlight lang="html">
Expand Down
6 changes: 3 additions & 3 deletions src/app/components/docs/docs.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ export class DocsComponent {
route: 'creating',
title: 'Creating new views',
}, {
description: 'Deploy your UI',
icon: 'local_shipping',
description: 'Build your UI',
icon: 'cached',
route: 'deployment',
title: 'Deployment',
title: 'Building',
}, {
description: 'Access 750+ Material Design icons',
icon: 'photo_size_select_actual',
Expand Down