Skip to content

Commit 827a717

Browse files
jamesdanielsjamesdaniels
authoredMay 14, 2024
Doc changes (#3525)
1 parent 1302e3a commit 827a717

8 files changed

+28
-29
lines changed
 

‎docs/analytics.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,8 @@ export class UserProfileComponent {
5454

5555
## Firebase API
5656

57-
The [Firebase API for Google Analytics documentation](https://firebase.google.com/docs/reference/js/analytics.md#analytics_package) is available on the Firebase website.
57+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5858

59-
## Services
60-
61-
### ScreenTrackingService
62-
63-
Coming soon, for now [please review the documentation](https://firebase.google.com/docs/analytics/screenviews)
64-
65-
### UserTrackingService
66-
Coming soon
59+
Update the imports from `import { ... } from 'firebase/analytics'` to `import { ... } from '@angular/fire/analytics'` and follow the official documentation.
6760

61+
[Getting Started](https://firebase.google.com/docs/analytics/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/analytics)

‎docs/app-check.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<small>
2-
<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; Realtime App Check
2+
<a href="https://github.com/angular/angularfire">AngularFire</a> &#10097; <a href="../README.md#developer-guide">Developer Guide</a> &#10097; App Check
33
</small>
44

55
<img align="right" width="30%" src="images/reCAPTCHA-logo@1x.png">
@@ -47,7 +47,8 @@ export class AppCheckComponent {
4747

4848
## Firebase API
4949

50-
The [AppCheck documentation](https://firebase.google.com/docs/reference/js/app-check) is available on the Firebase website.
50+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5151

52-
## Convenience observables
53-
Coming soon.
52+
Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation.
53+
54+
[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check)

‎docs/database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ extend class DepartmentComponent {
5050

5151
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5252

53-
Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the offical documentation.
53+
Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the official documentation.
5454

5555
[Getting Started](https://firebase.google.com/docs/database/web/start) | [API Reference](https://firebase.google.com/docs/reference/js/database)
5656

‎docs/firestore.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,15 @@ export class UserProfileComponent {
5656
```
5757

5858
## Firebase API
59-
With the reference to Cloud Firestore available in a component it is now possible to connect read from and write to the database.
59+
60+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
61+
62+
Update the imports from `import { ... } from 'firebase/firestore'` to `import { ... } from '@angular/fire/firestore'` and follow the official documentation.
63+
64+
[Getting Started](https://firebase.google.com/docs/firestore/quickstart#web-modular-api) | [API Reference](https://firebase.google.com/docs/reference/js/firestore)
6065

6166
### Reading data
67+
6268
In Cloud Firestore data is stored in `documents` and `documents` are stored in `collections`. The path to data follows `<collection_name>/<document_id>` and continues if there are subcollections. For example, `"users/ABC12345/posts/XYZ6789"` represents:
6369
* `users` collection
6470
* document id `ABC12345`
@@ -111,6 +117,7 @@ export Interface UserProfile {
111117
The `async` pipe handles unsubscribing from observables.
112118

113119
### Writing data
120+
114121
To write to Cloud Firestore use the `addDoc` function. It will create a new document at the path specified by the collection. In `user-profile.component.ts`, we'll update the code to add a new document on a `<button>` click.
115122

116123

‎docs/functions.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ export class AppComponent {
4545
```
4646

4747
## Firebase API
48-
The [Firebase API for Cloud Functions documentation](https://firebase.google.com/docs/reference/js/functions) is available on the Firebase website.
4948

50-
## Convenience observables
49+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5150

52-
More details coming soon.
51+
Update the imports from `import { ... } from 'firebase/functions'` to `import { ... } from '@angular/fire/functions'` and follow the official documentation.
52+
53+
[Call functions from your app](https://firebase.google.com/docs/functions/callable?gen=2nd#web-modular-api) | [API Reference](https://firebase.google.com/docs/reference/js/functions)

‎docs/performance.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,8 @@ export class PerformanceComponent {
4646

4747
## Firebase API
4848

49-
The [Performance documentation](https://firebase.google.com/docs/reference/js/performance.md#performance_package) is available on the Firebase website.
49+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5050

51-
## Services
51+
Update the imports from `import { ... } from 'firebase/performance'` to `import { ... } from '@angular/fire/performance'` and follow the official documentation.
5252

53-
Coming soon.
54-
55-
## Convenience observables
56-
57-
Coming soon.
53+
[Getting Started](https://firebase.google.com/docs/perf-mon/get-started-web) | [API Reference](https://firebase.google.com/docs/reference/js/performance)

‎docs/remote-config.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ export class RemoteConfigComponent {
4646

4747
## Firebase API
4848

49-
The [Remote Config documentation](https://firebase.google.com/docs/reference/js/remote-config) is available on the Firebase website.
49+
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5050

51-
## Convenience observables
51+
Update the imports from `import { ... } from 'firebase/remote-config'` to `import { ... } from '@angular/fire/remote-config'` and follow the official documentation.
5252

53-
Coming soon.
53+
[Getting Started](https://firebase.google.com/docs/remote-config/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/remote-config)

‎docs/storage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export class StorageComponent {
5151

5252
AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API.
5353

54-
Update the imports from `import { ... } from 'firebase/storage'` to `import { ... } from '@angular/fire/storage'` and follow the offical documentation.
54+
Update the imports from `import { ... } from 'firebase/storage'` to `import { ... } from '@angular/fire/storage'` and follow the official documentation.
5555

5656
[Getting Started](https://firebase.google.com/docs/storage/web/start) | [API Reference](https://firebase.google.com/docs/reference/js/storage)
5757

0 commit comments

Comments
 (0)