Skip to content
This repository was archived by the owner on Apr 3, 2024. It is now read-only.

Commit afe9f53

Browse files
authored
docs: Update Firebase notes in README (#1128)
1 parent 5b8d3b1 commit afe9f53

File tree

2 files changed

+16
-30
lines changed

2 files changed

+16
-30
lines changed

.readme-partials.yaml

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,11 @@ body: |-
4949
with the longest matching path suffix. If a unique match is found, that file
5050
will be used to set the snapshot.
5151
52-
## Firebase Realtime Database backend
52+
## Snapshot Debugger - Firebase Realtime Database Backend
5353
54-
The Cloud Debugger API is deprecated and will be turned down in May 2023.
55-
56-
You can use Firebase Realtime Database for data persistence as an
57-
alternative.
58-
59-
### Enabling the agent
54+
This functionality is available for release 6.0.0 onward of this agent and
55+
provides support for the Snapshot Debugger, which is being provided as a
56+
replacement for the deprecated Cloud Debugger service.
6057
6158
To enable the agent, add the following at the top of your app's main script
6259
or entry point:
@@ -70,17 +67,13 @@ body: |-
7067
```
7168
7269
The following params are optional:
73-
* firebaseDbUrl - https://**PROJECT_ID**-cdbg.firebaseio.com will be used if not
74-
provided. where **PROJECT_ID** is your project ID.
70+
* firebaseDbUrl - https://**PROJECT_ID**-cdbg.firebaseio.com will be used if
71+
not provided. where **PROJECT_ID** is your project ID.
7572
* firebaseKeyPath - Default google application credentials are used if not
7673
provided.
7774
78-
### Using the Debugger
79-
80-
Using the Debugger with the Firebase Realtime Database backend requires using
81-
the Snapshot Debugger CLI.
82-
83-
See the [full Snapshot Debugger CLI documentation][snapshot-debugger-readme].
75+
See https://github.com/GoogleCloudPlatform/snapshot-debugger and
76+
https://cloud.google.com/debugger/docs/deprecations for more details.
8477
8578
## Limitations and Requirements
8679

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,11 @@ because the debug agent resolves a snapshot filename by searching for a file
9999
with the longest matching path suffix. If a unique match is found, that file
100100
will be used to set the snapshot.
101101

102-
## Firebase Realtime Database backend
102+
## Snapshot Debugger - Firebase Realtime Database Backend
103103

104-
The Cloud Debugger API is deprecated and will be turned down in May 2023.
105-
106-
You can use Firebase Realtime Database for data persistence as an
107-
alternative.
108-
109-
### Enabling the agent
104+
This functionality is available for release 6.0.0 onward of this agent and
105+
provides support for the Snapshot Debugger, which is being provided as a
106+
replacement for the deprecated Cloud Debugger service.
110107

111108
To enable the agent, add the following at the top of your app's main script
112109
or entry point:
@@ -120,17 +117,13 @@ require('@google-cloud/debug-agent').start({
120117
```
121118

122119
The following params are optional:
123-
* firebaseDbUrl - https://**PROJECT_ID**-cdbg.firebaseio.com will be used if not
124-
provided. where **PROJECT_ID** is your project ID.
120+
* firebaseDbUrl - https://**PROJECT_ID**-cdbg.firebaseio.com will be used if
121+
not provided. where **PROJECT_ID** is your project ID.
125122
* firebaseKeyPath - Default google application credentials are used if not
126123
provided.
127124

128-
### Using the Debugger
129-
130-
Using the Debugger with the Firebase Realtime Database backend requires using
131-
the Snapshot Debugger CLI.
132-
133-
See the [full Snapshot Debugger CLI documentation][snapshot-debugger-readme].
125+
See https://github.com/GoogleCloudPlatform/snapshot-debugger and
126+
https://cloud.google.com/debugger/docs/deprecations for more details.
134127

135128
## Limitations and Requirements
136129

0 commit comments

Comments
 (0)