Skip to content

Commit 3a39fe8

Browse files
committed
docs: Minor corrections
@JohannesHoppe Former-commit-id: 655a518
1 parent 854d8cb commit 3a39fe8

File tree

2 files changed

+49
-48
lines changed

2 files changed

+49
-48
lines changed

README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
[![CircleCI](https://circleci.com/gh/angular-schule/angular-cli-ghpages.svg?style=svg)](https://circleci.com/gh/angular-schule/angular-cli-ghpages)
44
[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?color=blue&style=flat-square)](http://opensource.org/licenses/MIT)
55

6-
Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
6+
**Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀**
77

88
![Screenshot](docs/angular-cli-ghpages-deploy.gif)
99

1010
**Table of contents:**
1111

1212
1. [📖 Changelog](#changelog)
1313
2. [⚠️ Prerequisites](#prerequisites)
14-
3. [🚀 Quick-start (local development)](#quickstart-local)
14+
3. [🚀 Quick Start (local development)](#quickstart-local)
1515
4. [🚀 Continuous Delivery](#continuous-delivery)
1616
5. [📦 Options](#options)
1717
- [--base-href](#base-href)
@@ -38,7 +38,7 @@ Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
3838
A detailed changelog is available in the [releases](https://github.com/angular-schule/angular-cli-ghpages/releases) section.
3939

4040
In the past this project was a standalone program.
41-
This is still possible.
41+
This is still possible:
4242
See the documentation at [README_standalone](docs/README_standalone).
4343

4444

@@ -52,12 +52,12 @@ This command has the following prerequisites:
5252

5353

5454

55-
## 🚀 Quick-start (local development) <a name="quickstart-local"></a>
55+
## 🚀 Quick Start (local development) <a name="quickstart-local"></a>
5656

57-
This quickstart assumes that you are starting from scratch.
58-
If you alreay have an existing Angular project on GitHub, skip step 1 and 2.
57+
This quick start assumes that you are starting from scratch.
58+
If you already have an existing Angular project on GitHub, skip step 1 and 2.
5959

60-
1. Install the next version of the Angular CLI (v8.3.0-next.0 or greater)
60+
1. Install the next version of the Angular CLI (v8.3.0-next.0 or greater) globally
6161
and create a new Angular project.
6262

6363
```sh
@@ -66,15 +66,15 @@ If you alreay have an existing Angular project on GitHub, skip step 1 and 2.
6666
cd your-angular-project
6767
```
6868

69-
2. By default the Angular CLI initializes a git repository for you.
69+
2. By default the Angular CLI initializes a Git repository for you.
7070
To add a new remote for GitHub, use the `git remote add` command:
7171

7272
```sh
7373
git remote add origin https://github.com/<username>/<repositoryname>.git
7474
```
7575

7676
Hints:
77-
* Create a new empty GithHub repository first.
77+
* Create a new empty GitHub repository first.
7878
* Replace `<username>` and `<repositoryname>` with your username from GitHub and the name of your new repository.
7979
* Please enter the URL `https://github.com/<username>/<repositoryname>.git` into your browser – you should see your existing repository on GitHub.
8080
* Please double-check that you have the necessary rights to make changes to the given project!
@@ -85,8 +85,8 @@ If you alreay have an existing Angular project on GitHub, skip step 1 and 2.
8585
ng add angular-cli-ghpages
8686
```
8787

88-
4. Deploy your project to Github pages with all default settings.
89-
Your project will be automatically build in production mode.
88+
4. Deploy your project to GitHub pages with all default settings.
89+
Your project will be automatically built in production mode.
9090

9191
```sh
9292
ng deploy
@@ -105,12 +105,12 @@ If you alreay have an existing Angular project on GitHub, skip step 1 and 2.
105105

106106
## 🚀 Continuous Delivery <a name="continuous-delivery"></a>
107107

108-
If you run this command on a CI/CD environment, the deployment will most likely not work out of the box.
109-
For security reasons, those environments usually have read-only privileges or you haven't set up git correctly.
110-
Therefore you should take a look at [Github tokens](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
111-
In short: a Github token replaces username and password and is a safer choice because a token can be revoked at any time.
108+
If you run this command from a CI/CD environment, the deployment will most likely not work out of the box.
109+
For security reasons, those environments usually have read-only privileges or you haven't set up Git correctly.
110+
Therefore you should take a look at [GitHub tokens](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
111+
In short: a GitHub token replaces username and password and is a safer choice because a token can be revoked at any time.
112112

113-
All you need to do is set an environment variable called `GH_TOKEN` in our CI/CD environment.
113+
All you need to do is to set an environment variable called `GH_TOKEN` in your CI/CD environment.
114114
You should also set the URL to the repository using the `--repo` option.
115115
The URL must use the HTTPS scheme.
116116

@@ -131,19 +131,19 @@ ng deploy --repo=https://github.com/<username>/<repositoryname>.git --name="Your
131131
* __optional__
132132
* Default: `undefined` (string)
133133
* Example:
134-
* `ng deploy` -- `<base href="/">` stays untouched in your `index.html`
134+
* `ng deploy` -- `<base href="/">` remains unchanged in your `index.html`
135135
* `ng deploy --base-href=/the-repositoryname` -- `<base href="/the-repositoryname">` is added to your `index.html`
136136

137-
Specifies the base url for the application being built.
137+
Specifies the base URL for the application being built.
138138
Same as `ng build --base-href=XXX`
139139

140140
**ℹ️ Please read the next lines carefully, or you will get 404 errors in case of a wrong configuration!**
141141

142142
##### A) You don't want to use a custom domain
143143

144-
If you don't want to use an own domain, then your later URL of your hostet Angular project should look like this:
144+
If you don't want to use an own domain, then your later URL of your hosted Angular project should look like this:
145145
`https://your-username.github.io/the-repositoryname`.
146-
In this case you have to adjust the `--base-href`:
146+
In this case you have to adjust the `--base-href` accordingly:
147147

148148
```sh
149149
ng deploy --base-href=/the-repositoryname
@@ -162,10 +162,10 @@ See the option [--cname](#cname) for more information!
162162

163163
#### --repo <a name="repo"></a>
164164
* __optional__
165-
* Default: url of the origin remote of the current dir (assumes a git repository)
165+
* Default: URL of the origin remote of the current dir (assumes a Git repository)
166166
* Example: `ng deploy --repo=https://github.com/<username>/<repositoryname>.git`
167167

168-
By default, this command assumes that the current working directory is a git repository,
168+
By default, this command assumes that the current working directory is a Git repository,
169169
and that you want to push changes to the `origin` remote.
170170
If instead your files are not in a git repository, or if you want to push to another repository,
171171
you can provide the repository URL in the `repo` option.
@@ -174,7 +174,7 @@ you can provide the repository URL in the `repo` option.
174174
Set an environment variable with the name `GH_TOKEN` and it will be automatically added to the URL.
175175
(`https://github.com/<username>/<repositoryname>.git` is changed to `https://XXX@github.com/<username>/<repositoryname>.git`
176176
if there is an environment variable `GH_TOKEN` with the value `XXX`.
177-
Learn more about [Github tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).)
177+
Learn more about [GitHub tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).)
178178

179179

180180
#### --configuration <a name="configuration"></a>
@@ -208,18 +208,18 @@ if the environment variable `CIRCLECI` exists (for Circle CI).
208208
The name of the branch you'll be pushing to.
209209
The default uses GitHub's `gh-pages` branch,
210210
but this can be configured to push to any branch on any remote.
211-
You have to change this to `master` if you are pushing to an GitHub organisation page (instead of an GitHub user page).
211+
You have to change this to `master` if you are pushing to a GitHub organization page (instead of a GitHub user page).
212212

213213

214214
#### --name & --email <a name="name"></a>
215215
* __optional__
216216
* Default: value of `git config user.name` and `git config user.email`
217217
* Example: `ng deploy --name="Displayed Username" --email=mail@example.org`
218218

219-
If you are running the command in a repository without a `user.name` or `user.email` git config properties
219+
If you run the command in a repository without `user.name` or `user.email` Git config properties
220220
(or on a machine without these global config properties),
221-
you must provide user info before git allows you to commit.
222-
In this case provide **both** `name` and `email` string values to identify the committer.
221+
you must provide user info before Git allows you to commit.
222+
In this case, provide **both** `name` and `email` string values to identify the committer.
223223

224224

225225
#### --no-silent <a name="no-silent"></a>
@@ -230,12 +230,12 @@ In this case provide **both** `name` and `email` string values to identify the c
230230
* `ng deploy --no-silent` -- Logging shows extended information.
231231

232232
Logging is in silent mode by default.
233-
In silent mode log messages are suppressed and error messages are sanitized.
233+
In silent mode, log messages are suppressed and error messages are sanitized.
234234

235235
The `--no-silent` option enables extended console logging.
236236
Keep this untouched if the repository URL or other information passed to git commands is sensitive!
237237

238-
> WARNING: This option should kept like it is if the repository URL or other information passed to git commands is sensitive and should not be logged (== you have a public build server and you are using the `GH_TOKEN` feature).
238+
> WARNING: This option should be kept as it is if the repository URL or other information passed to Git commands is sensitive and should not be logged (== you have a public build server and you are using the `GH_TOKEN` feature).
239239
> By default the silent mode is enabled to avoid sensitive data exposure.
240240
241241

@@ -250,39 +250,39 @@ The command includes dotfiles by default (e.g `.htaccess` will be committed)
250250
With `--no-dotfiles` files starting with `.` are ignored.
251251

252252
**Hint:**
253-
This is super usefull if you want to publish a `.nojekyll` file.
254-
Create such a file in the root of your pages repo to bypass the Jekyll static site generator on Github Pages.
255-
Static content is still delivered even without Jekyll.
253+
This is super useful if you want to publish a `.nojekyll` file.
254+
Create such a file in the root of your pages repo to bypass the Jekyll static site generator on GitHub Pages.
255+
Static content is still delivered -- even without Jekyll.
256256
This should only be necessary if your site uses files or directories that start with **_underscores** since Jekyll considers these to be special resources and does not copy them to the final site.
257257
→ Or just don't use underscores!
258258

259259

260260
#### --cname <a name="cname"></a>
261261
* __optional__
262-
* Default: `undefined` (string) No CNAME file is generated
262+
* Default: `undefined` (string) -- No CNAME file is generated
263263
* Example:
264264
* `ng deploy --cname=example.com`
265265

266266
A CNAME file will be created enabling you to use a custom domain.
267-
[More information on Github Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
267+
[More information on GitHub Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
268268

269269

270270
#### --dry-run <a name="dry-run"></a>
271271
* __optional__
272272
* Default: `false` (boolean)
273273
* Example:
274-
* `ng deploy` -- Normal behaviour: Changes are applied.
274+
* `ng deploy` -- Normal behavior: Changes are applied.
275275
* `ng deploy --dry-run` -- No changes are applied at all.
276276

277277
Run through without making any changes.
278-
This can be very usefull, because it outputs what would happend without doing anything.
278+
This can be very useful because it outputs what would happen without doing anything.
279279

280280

281281

282282
## 🏁 Next milestones <a name="milestones"></a>
283283

284284
We are glad that we have an integration into the CLI again.
285-
But we are looking forward to the following features:
285+
However, we are looking forward to the following features:
286286

287287
* an interactive command-line prompt that guides you through the available options
288288
* a configuration file (`angular-cli-ghpages.json`) to avoid all these command-line cmd options

docs/README_contributors.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ npm test
1414

1515
## Local development <a name="local-dev"></a>
1616

17-
If you want to try the latest package locally without installing it from npm, use the following instructions.
18-
This may be useful when you want to try the latest non published version of this library or you want to make a contribution.
17+
If you want to try the latest package locally without installing it from NPM, use the following instructions.
18+
This may be useful when you want to try the latest non-published version of this library or you want to make a contribution.
1919

2020
Follow the instructions for [checking and updating the Angular CLI version](#angular-cli) and then link the package.
2121

@@ -28,7 +28,7 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
2828
npm install -g @angular/cli@next
2929
```
3030

31-
2. Run `ng --version`, make sure you have angular CLI v8.3.0-next.0 or greater.
31+
2. Run `ng version`, make sure you have installed Angular CLI v8.3.0-next.0 or greater.
3232

3333
3. Update your existing project using the command:
3434

@@ -68,13 +68,14 @@ Use the following instructions to make `angular-cli-ghpages` available locally v
6868
npm link
6969
```
7070

71+
Read more about the `link` feature in the [official NPM documentation](https://docs.npmjs.com/cli/link).
7172

72-
### 3. Adding to an Angular project - ng add <a name="local-dev-add"></a>
7373

74-
Once you have completed the previous steps to npm link the local copy of `angular-cli-ghpages`,
75-
follow these steps to use it in a local angular project.
74+
### 3. Adding to an Angular project -- ng add <a name="local-dev-add"></a>
7675

77-
1. Enter the project's directory
76+
Once you have completed the previous steps to `npm link` the local copy of `angular-cli-ghpages`, follow these steps to use it in a local Angular project.
77+
78+
1. Enter the project directory
7879

7980
```sh
8081
cd your-angular-project
@@ -86,13 +87,13 @@ follow these steps to use it in a local angular project.
8687
npm link angular-cli-ghpages
8788
```
8889

89-
3. Now execute the schematic.
90+
3. Now execute the `ng-add` schematic.
9091

9192
```sh
9293
ng add angular-cli-ghpages
9394
```
9495

95-
4. Now you can deploy your angular app to Github pages.
96+
4. You can now deploy your angular app to GitHub pages.
9697

9798
```sh
9899
ng run your-angular-project:deploy
@@ -118,10 +119,10 @@ npm test
118119
## Testing the standalone CLI
119120

120121
To quickly test the file `engine.ts` directly, the standalone mode is the best option.
121-
Use VSCode and debug the task `Launch Standalone Program"`.
122+
Use VSCode and debug the task `Launch Standalone Program`.
122123

123124

124-
## Publish to npm
125+
## Publish to NPM
125126

126127
```
127128
cd angular-cli-ghpages/src

0 commit comments

Comments
 (0)