From f3f0148ca1109e5c7a12dc48951a999f238b6400 Mon Sep 17 00:00:00 2001 From: James Daniels Date: Tue, 14 May 2024 15:20:05 -0400 Subject: [PATCH] Doc changes --- docs/analytics.md | 12 +++--------- docs/app-check.md | 9 +++++---- docs/database.md | 2 +- docs/firestore.md | 9 ++++++++- docs/functions.md | 7 ++++--- docs/performance.md | 10 +++------- docs/remote-config.md | 6 +++--- docs/storage.md | 2 +- 8 files changed, 28 insertions(+), 29 deletions(-) diff --git a/docs/analytics.md b/docs/analytics.md index 2269b2666..f7002da35 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -54,14 +54,8 @@ export class UserProfileComponent { ## Firebase API -The [Firebase API for Google Analytics documentation](https://firebase.google.com/docs/reference/js/analytics.md#analytics_package) is available on the Firebase website. +AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API. -## Services - -### ScreenTrackingService - -Coming soon, for now [please review the documentation](https://firebase.google.com/docs/analytics/screenviews) - -### UserTrackingService -Coming soon +Update the imports from `import { ... } from 'firebase/analytics'` to `import { ... } from '@angular/fire/analytics'` and follow the official documentation. +[Getting Started](https://firebase.google.com/docs/analytics/get-started?platform=web) | [API Reference](https://firebase.google.com/docs/reference/js/analytics) diff --git a/docs/app-check.md b/docs/app-check.md index 41175cb04..0674f29ee 100644 --- a/docs/app-check.md +++ b/docs/app-check.md @@ -1,5 +1,5 @@ -AngularFire ❱ Developer Guide ❱ Realtime App Check +AngularFire ❱ Developer Guide ❱ App Check @@ -47,7 +47,8 @@ export class AppCheckComponent { ## Firebase API -The [AppCheck documentation](https://firebase.google.com/docs/reference/js/app-check) is available on the Firebase website. +AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API. -## Convenience observables -Coming soon. \ No newline at end of file +Update the imports from `import { ... } from 'firebase/app-check'` to `import { ... } from '@angular/fire/app-check'` and follow the official documentation. + +[Getting Started](https://firebase.google.com/docs/app-check/web/recaptcha-enterprise-provider) | [API Reference](https://firebase.google.com/docs/reference/js/app-check) diff --git a/docs/database.md b/docs/database.md index 5d0bb0df8..6a3994454 100644 --- a/docs/database.md +++ b/docs/database.md @@ -50,7 +50,7 @@ extend class DepartmentComponent { AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API. -Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the offical documentation. +Just change your imports from `import { ... } from 'firebase/database'` to `import { ... } from '@angular/fire/database'` and follow the official documentation. [Getting Started](https://firebase.google.com/docs/database/web/start) | [API Reference](https://firebase.google.com/docs/reference/js/database) diff --git a/docs/firestore.md b/docs/firestore.md index b1c5b5030..044bf9e1a 100644 --- a/docs/firestore.md +++ b/docs/firestore.md @@ -56,9 +56,15 @@ export class UserProfileComponent { ``` ## Firebase API -With the reference to Cloud Firestore available in a component it is now possible to connect read from and write to the database. + +AngularFire wraps the Firebase JS SDK to ensure proper functionality in Angular, while providing the same API. + +Update the imports from `import { ... } from 'firebase/firestore'` to `import { ... } from '@angular/fire/firestore'` and follow the official documentation. + +[Getting Started](https://firebase.google.com/docs/firestore/quickstart#web-modular-api) | [API Reference](https://firebase.google.com/docs/reference/js/firestore) ### Reading data + In Cloud Firestore data is stored in `documents` and `documents` are stored in `collections`. The path to data follows `/` and continues if there are subcollections. For example, `"users/ABC12345/posts/XYZ6789"` represents: * `users` collection * document id `ABC12345` @@ -111,6 +117,7 @@ export Interface UserProfile { The `async` pipe handles unsubscribing from observables. ### Writing data + 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 `