Skip to content

typo and grammar fixes in docs #1931

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.

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

Merged
merged 14 commits into from
Oct 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/deploying-angularfire-to-firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
### 0. Build your Angular project for production

Before you can deploy your angular project, you need to build a version with your prod environment variables.
Make sure to add your production firebase configuraiton to the src/environments/environment.prod.ts before you build.
Make sure to add your production firebase configuration to the src/environments/environment.prod.ts before you build.

```bash
# build the angular project, creates a dist folder in your directory
Expand All @@ -12,7 +12,7 @@ ng build --prod

### 1. Initializing a Firebase project

You must initialize Firebase Hosting in order to deploy your application. In order to do this run the `firebase init` command.
You must initialize Firebase Hosting in order to deploy your application. In order to do this, run the `firebase init` command.

Note: If you haven't installed the Firebase CLI yet, run this command:

Expand All @@ -21,11 +21,11 @@ npm install --global firebase-tools
```

- This command prompts you to enter a public directory. Enter `dist` (generated by `ng build -prod`).
- The command will also ask you if you want to overwrite your index file. Type `n` since your Angular app includes a index file.
- The command will also ask you if you want to overwrite your index file. Type `n` since your Angular app includes an index file.
- This command also prompts you whether to configure the project as a single-page app. Enter `y` if you're using Angular Router or similar. Otherwise, enter `n`.

### 2. Deploy your Project

To deploy your app, simply run `firebase deploy`!

For more information on Firebase `init` and `deploy` commands, checkout the [Firebase CLI documentation](https://firebase.google.com/docs/cli/).
For more information on Firebase `init` and `deploy` commands, check out the [Firebase CLI documentation](https://firebase.google.com/docs/cli/).
2 changes: 1 addition & 1 deletion docs/install-and-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### 0. Prerequisites

AngularFire provides multiple module formats for different types of builds. The guide is based off the Angular CLI. It is possible to do a manual setup with Webpack or a SystemJS build as well.
AngularFire provides multiple module formats for different types of builds. The guide is based on the Angular CLI. It is possible to do a manual setup with Webpack or a SystemJS build as well.

```bash
npm install @angular/cli
Expand Down
2 changes: 1 addition & 1 deletion docs/install-angular-cli-windows10.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installing Angular CLI on Windows 10

> There had been installation issues of `@angular/cli` on Windows 10 system. Most of the time these errors are related to Python dependecies and node-gyp.
> There had been installation issues of `@angular/cli` on Windows 10 system. Most of the time these errors are related to Python dependencies and node-gyp.

Something as below :

Expand Down
2 changes: 1 addition & 1 deletion docs/version-4-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ AngularFire2 4.0 is a refactor of the AngularFire2 package which implements

### Removing `AngularFire` for Modularity

Prior to 4.0, AngularFire2 did not take advantage of the Firebase SDK's modularity for tree shaking. The `AngularFire` service has now been removed and the library broken up into smaller `@NgModule`s:
Prior to 4.0, AngularFire2 did not take advantage of the Firebase SDK's modularity for tree shaking. The `AngularFire` service has now been removed and the library is broken up into smaller `@NgModule`s:

* `AngularFireModule`
* `AngularFireDatabaseModule`
Expand Down
2 changes: 1 addition & 1 deletion docs/version-5-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ AngularFire 5.0 is a refactor of the `AngularFireDatabase` module. It removes th

## Updating `FirebaseListObservable` to `AngularFireList<T>`

Rather than `.list()` returning a `FirebaseListObservable`, it now returns an `AngularFireList<T>`. This service contains methods that allow you manipulate and stream data.
Rather than `.list()` returning a `FirebaseListObservable`, it now returns an `AngularFireList<T>`. This service contains methods that allow you to manipulate and stream data.

In the case of streaming back data, you now call one of the observable methods on `AngularFireList`.

Expand Down