Skip to content

Commit 2162e13

Browse files
authored
Finish up docs images restructure (#1023)
* a bunch * legacy paywalls * kill orchestration legacy page * firebase * delete unused * docusaurus images * fix epa * favicon * readme * fix build * compress images save 36mb
1 parent c7e6369 commit 2162e13

File tree

594 files changed

+129
-234
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

594 files changed

+129
-234
lines changed

docs/integrations/third-party-integrations/firebase-integration.mdx

Lines changed: 34 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -73,28 +73,20 @@ Setting an incorrect app instance ID will prevent events from displaying in Goog
7373

7474
You can "turn on" the integration from the RevenueCat dashboard.
7575

76-
1. Navigate to your project in the RevenueCat dashboard and find the _Integrations_ card in the left menu. Select **+ New**
76+
1. Navigate to your project settings in the RevenueCat dashboard and choose 'Firebase' from the Integrations menu
7777

78-
![](/images/2e171f1-app.revenuecat.com_projects_85ff18c7_collaborators_1_0de54352ac248f736f890b4377994a78.png)
78+
![Integration setup](/docs_images/integrations/setup-integrations.png)
7979

80-
2. Choose **Firebase** from the integrations menu
80+
2. Add your Firebase App ID and API secret for your iOS app and/or Android app
8181

82-
![Firebase Google Analytics configuration screen](/images/44d871d-app.revenuecat.com_projects_85ff18c7_integrations_branch_11_875236ae360f769f5e875e0409ca81c3.png)
82+
To set up your Firebase App ID, navigate to `Google Analytics > Admin > Data Streams > iOS/Android > Add Stream`. Open the App Stream to find your Firebase App ID. Copy and paste into the RevenueCat settings page.
8383

84-
3. Add your Firebase App ID and API secret for your iOS app and/or Android app
85-
86-
To set up your Firebase App ID, navigate to Google Analytics > Admin > Data Streams > iOS/Android > Add Stream. Open the App Stream to find your Firebase App ID. Copy and paste into the RevenueCat settings page.
87-
88-
![Data stream details page](/images/a4ad055-Screen_Shot_2022-04-05_at_11.03.48_33e283c7cc08eec929b4acea4f84fccc.png)
84+
![Data stream details page](/docs_images/integrations/third-party-integrations/firebase/data-stream-details.png)
8985

9086
To find your API secret, in the same _App stream details_ page select "Measure Protocol API secrets". Create an API secret. Copy and paste into the RevenueCat settings page.
9187

92-
![Measurement Protocol API secrets page](/images/1f83e41-app.revenuecat.com_projects_85ff18c7_integrations_branch_11_a45c894afae02364212a054e6778b527.png)
93-
94-
4. Select whether you want RevenueCat to report sales in purchased currency (original currency or in US dollar)
95-
5. Select whether you want sales reported as gross revenue (before app store commission), or after store commission and/or estimated taxes.
96-
97-
Remember to select 'Add Integration'.
88+
3. Select whether you want RevenueCat to report sales in purchased currency (original currency or in US dollar)
89+
4. Select whether you want sales reported as gross revenue (before app store commission), or after store commission and/or estimated taxes.
9890

9991
### Events
10092

@@ -124,7 +116,7 @@ Simulate a new user installing your app, and go through your app flow to complet
124116

125117
Navigate to Google Analytics > Reports > Realtime. Here you will be able to confirm events have been successfully dispatched to Google Analytics. It can take up to a few seconds or minutes for your events to appear.
126118

127-
![Google Analytics dashboard](/images/7940d21-Screen_Shot_2022-07-25_at_1.50.22_PM_c755b71caa2948ec963a29a4e587c7e0.png)
119+
![Google Analytics dashboard](/docs_images/integrations/third-party-integrations/firebase/google-analytics-dashboard.png)
128120

129121
:::success
130122
You have completed the Google Analytics setup! You can stop here or continue with the rest of the documentation to learn how to set up the Firebase Extension.
@@ -163,35 +155,35 @@ Follow [this installation link](https://console.firebase.google.com/project/_/ex
163155

164156
1. Select 'I acknowledge'
165157

166-
![](/images/0480fb7-1_45394b0e896bb56bd1e9f052f5997cb1.png "1.png")
158+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-1.png)
167159

168160
2. If your account is not set up for billing yet, select 'Upgrade project to continue'
169161

170-
![](/images/a11cefc-2_517be863b03c025709a6a4eba9c96ea5.png "2.png")
162+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-2.png)
171163

172164
3. Enable Authentication and Secret Manager by selecting 'Enable', then select 'Next'
173165

174-
![](/images/f0a1273-3_392debc6fc67da81cc5b05890a3acbf7.png "3.png")
166+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-3.png)
175167

176168
4. Select 'Next'
177169

178-
![](/images/f1021a5-4_cd19bfe292fd0c1eb10393c3c18a4e3b.png "4.png")
170+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-4.png)
179171

180172
5. Configure the extension
181173

182-
![](/images/99fe4d8-5_88e39c8de533f1b89585b431b0ee4ca1.png "5.png")
174+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-5.png)
183175

184176
- Select a Cloud Functions location
185177
- (optional) Give a name to the Firestore collection where "events" will be stored
186178
- (optional) Give a name to the Firestore collection where "customers" will be stored
187179
- Enable or disable custom claims set in Firebase Auth with user's active entitlements. If set to “ENABLED”, the extension will consider the `app_user_id` of the user to match the user’s Firebase Authentication UID and set a “Custom Claim” with their current active entitlements
188180
- Enter your RevenueCat Firebase Integration Shared Secret. This can be found in the RevenueCat Firebase Extension settings page. Select 'Generate shared secret' and copy it. Paste the generated shared secret in the installation prompt.
189181

190-
![](/images/41e22f5-Screenshot_2023-03-28_at_3.05.07_PM_485b7c7c4024b6dcd1785fcad49eb12b.png)
182+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-6.png)
191183

192184
- (optional) Enable events to write custom event handlers via [Eventarc](https://firebase.google.com/docs/extensions/install-extensions?authuser=0&hl=en&platform=console#eventarc)
193185

194-
![](/images/2265dfc-enable_events_11bfd8ecb376ad69af803a653c8d5070.png "enable_events.png")
186+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-7.png)
195187

196188
##### Available Events:
197189

@@ -214,9 +206,9 @@ Follow [this installation link](https://console.firebase.google.com/project/_/ex
214206

215207
6. Once the extension is installed, navigate to Firebase > Functions in the sidebar. Copy the 'Trigger URL' and paste this into the RevenueCat Firebase Extension settings page.
216208

217-
![](/images/4416a89-Screen_Shot_2022-04-14_at_11.18.59_5355014091f6b4f845181de8a51a3157.png "Screen Shot 2022-04-14 at 11.18.59.png")
209+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-8.png)
218210

219-
![](/images/a8c5e19-Screen_Shot_2022-04-15_at_2.08.18_PM_619e3596f4922cb3f94a3b66553145a6.png "Screen Shot 2022-04-15 at 2.08.18 PM.png")
211+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-9.png)
220212

221213
Remember to select 'Save'
222214

@@ -233,55 +225,55 @@ This portion of the installation is done through the command-line interface (CLI
233225
1. Run `firebase ext:install . --project [project-id]`
234226
To find your `project-id`, go to your [Firebase console](https://console.firebase.google.com/u/0/). Select your project and navigate to Project settings to copy the ID and replace `[project-id]` in the command.
235227

236-
![](/images/5a32c66-Screen_Shot_2022-04-14_at_11.30.52_c10aa54a363b7984b0eaff7f61e1fde7.png "Screen Shot 2022-04-14 at 11.30.52.png")
228+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-10.png)
237229

238-
![](/images/9ab4401-Screen_Shot_2022-04-14_at_11.31.32_38636489c46aa265c8f473f1d4b90827.png "Screen Shot 2022-04-14 at 11.31.32.png")
230+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-11.png)
239231

240-
![](/images/3f08828-unnamed_e9a9aeb7dc2cb42c5399dd091e8d804b.png "unnamed.png")
232+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-12.png)
241233

242234
2. For the next 2 `Do you wish to continue?` prompts, press `y`
243235

244-
![](/images/6dc5e66-2_14d0e62169168ef55c683500db2e6053.png "2.png")
236+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-13.png)
245237

246238
3. `Please enter a new name for this instance:` Give the extension a name of your choice
247239

248-
![](/images/e107a6d-3_052eae56d88e8aa33610a5515543b8ee.png "3.png")
240+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-14.png)
249241

250242
4. `Which option do you want enabled for this parameter (Cloud Functions location)?` Select your desired location
251243

252-
![](/images/01786f5-4_865e0867949458a3157080786ac9236e.png "4.png")
244+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-15.png)
253245

254246
5. `Enter a value for RevenueCat Webhook Events Firestore collection:` Give a name to the Firestore collection where "events" will be stored. If left blank, RevenueCat will not save events.
255247

256-
![](/images/b9cfb9a-5_58eb9b79dba12524d6759027c5e2a182.png "5.png")
248+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-16.png)
257249

258250
6. `Enter a value for location of the customers collection:` Give a name to the Firestore collection where the customer information will be stored. If left blank, RevenueCat will not save customer information.
259251

260-
![](/images/5260f64-6_935819b60c397b33c74f2f25720ce9fd.png "6.png")
252+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-17.png)
261253

262254
7. `Which option do you want enabled for this parameter (custom claims set in Firebase Auth with the user's active entitlements):` If you want to use the custom claims feature, which allows for automatic checking for Entitlements, select `ENABLED`.
263255

264-
![](/images/42cb394-7_33bf00bd22ae0f056bd66adc781445cd.png "7.png")
256+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-18.png)
265257

266258
8. `Enter a value for RevenueCat Firebase Integration Shared Secret:` This can be found in the RevenueCat Firebase Extension settings page. Select 'Generate shared secret' and copy it. Paste the generated shared secret in the installation prompt.
267259

268-
![RevenueCat Firebase Extension page](/images/21aa4cf-Screenshot_2023-03-28_at_3.05.07_PM_91e1372800a05f872f0765e8228729ae.png "RevenueCat Firebase Extension page")
260+
![RevenueCat Firebase Extension page](/docs_images/integrations/third-party-integrations/firebase/firebase-console-19.png)
269261

270-
![](/images/32e8934-8_ba72f3b666265def2ac1c1f9d63e747b.png "8.png")
262+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-20.png)
271263

272264
9. Wait about 3 to 5 minutes for the installation
273265

274-
![](/images/2caa47a-9_3705dcdd0ea176944f6ccdb0a3cd5bfb.png "9.png")
266+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-21.png)
275267

276268
10. Once the extension is installed, navigate to Firebase > Functions in the sidebar. Copy the 'Trigger URL' and paste this into the RevenueCat Firebase Extension settings page.
277269

278-
![](/images/4416a89-Screen_Shot_2022-04-14_at_11.18.59_5355014091f6b4f845181de8a51a3157.png "Screen Shot 2022-04-14 at 11.18.59.png")
270+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-8.png)
279271

280272
##### Note about the App User ID's in the Customers collection
281273

282274
The document ID's in the Customers collection will always be an App User ID. Specifically, it will be the customer's most recently active alias. This means that the document ID for each customer may switch between [anonymous ID's](/customers/user-ids#anonymous-app-user-ids) and [custom ID's](/customers/user-ids#logging-in-with-a-custom-app-user-id), if they are both used in your app. If you would like to only use custom ID's, you can [learn more about that here](/customers/user-ids#how-to-never-see-anonymous-app-user-ids).
283275

284-
![](/images/a8c5e19-Screen_Shot_2022-04-15_at_2.08.18_PM_619e3596f4922cb3f94a3b66553145a6.png "Screen Shot 2022-04-15 at 2.08.18 PM.png")
276+
![](/docs_images/integrations/third-party-integrations/firebase/firebase-console-9.png)
285277

286278
Remember to select 'Save'.
287279

@@ -299,15 +291,13 @@ Simulate a new user installing your app, and go through your app flow to complet
299291

300292
While still on the Customer View, select the purchase event in the [Customer History](/dashboard-and-metrics/customer-history) page and make sure that the Firebase (Firebase function) integration event exists and was delivered successfully.
301293

302-
![](/images/02ff787-Screen_Shot_2022-05-09_at_7.09.39_PM_06eb1d4e603c44b7ebcdf717b95bfbe0.png "Screen Shot 2022-05-09 at 7.09.39 PM.png")
303-
304294
#### Check Firestore Database Collections
305295

306296
Navigate to your Firebase dashboard > Firestore Database to find events sent for your collections.
307297

308-
![Customers collection](/images/6e4ad8e-Screen_Shot_2022-04-25_at_13.19.54_7fa618d818ff07466a87db2428fbca92.png "Screen Shot 2022-04-25 at 13.19.54.png")
298+
![Customers collection](/docs_images/integrations/third-party-integrations/firebase/firestore-customers-collection.png)
309299

310-
![Events collection](/images/8d67ecd-Screen_Shot_2022-04-25_at_13.20.16_f9a631e80a90fd063a816a3535f8d1ad.png "Screen Shot 2022-04-25 at 13.20.16.png")
300+
![Events collection](/docs_images/integrations/third-party-integrations/firebase/firestore-events-collection.png)
311301

312302
### Sample Events
313303

@@ -400,7 +390,7 @@ If you get a 403 error in DeploymentManager when trying to install or uninstall
400390

401391
Now try uninstalling and/or reinstalling the extension.
402392

403-
![](/images/d93b3ea-2023-04-18_21.56.29_console.cloud.google.com_c3436c460f71_c4c062996771e0d9de57ee53f3a52cd0.png)
393+
![](/docs_images/integrations/third-party-integrations/firebase/invalid-api-version-error.png)
404394

405395
### InvalidApiVersionError: The version of this extension is not the same.
406396

docs/sdk-guides/ios-native-3x-to-4x-migration.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ To start us off, our framework name changed from `Purchases` to `RevenueCat`!
4949

5050
Select your target in Xcode, then go to Build Phases, and ensure that your target's `Link Binary with Libraries` section references `RevenueCat`, and remove the reference to `Purchases` if it was still there.
5151

52-
| Before | After |
53-
| :----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
54-
| ![link binary with libraries before](/images/link_binary_with_libraries_before_spm_2d2fe96e46481d9156daa017c10595ac.png) | ![link binary with libraries after](/images/link_binary_with_libraries_after_spm_1b11bf2cbd0e465cc67a1d773995b65e.png) |
52+
| Before | After |
53+
| :--------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------: |
54+
| ![link binary with libraries before](/docs_images/sdk/guides/ios-3x-4x/link-binary-before.png) | ![link binary with libraries after](/docs_images/sdk/guides/ios-3x-4x/link-binary-after.png) |
5555

5656
**Note:**
5757

@@ -78,10 +78,10 @@ Select your target in Xcode, then go to Build Phases, and ensure that your targe
7878
references `RevenueCat`, and remove the reference to `Purchases` if it was still there.
7979
Do the same with the Embed Frameworks section.
8080

81-
| Before | After |
82-
| :---------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: |
83-
| ![link binary with libraries before](/images/link_binary_with_libraries_before_carthage_1d5f4091a6f1a1d83bdf9494f09e9065.png) | ![link binary with libraries after](/images/link_binary_with_libraries_after_carthage_66365be8f3631be0f52792575fead228.png) |
84-
| ![embed frameworks before](/images/embed_frameworks_before_carthage_87327ac0b343e9090e18fcadf8c05a3c.png) | ![embed frameworks after](/images/embed_frameworks_after_carthage_1c6a63d57aaa71103d674cd19f383f7f.png) |
81+
| Before | After |
82+
| :-----------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------: |
83+
| ![link binary with libraries before](/docs_images/sdk/guides/ios-3x-4x/link-binary-before-carthage.png) | ![link binary with libraries after](/docs_images/sdk/guides/ios-3x-4x/link-binary-after-carthage.png) |
84+
| ![embed frameworks before](/docs_images/sdk/guides/ios-3x-4x/embed-frameworks-before-carthage.png) | ![embed frameworks after](/docs_images/sdk/guides/ios-3x-4x/embed-frameworks-after-carthage.png) |
8585

8686
###### 1.3.2 Using Platform-specific frameworks
8787

docs/test-and-launch/app-store-rejections.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Usually the reviewer will include a screenshot with the problem they encountered
2929

3030
Often times, purchases will work fine in Sandbox and Testflight, but App Store Review will not be able to fetch products. It's important to ensure that you are submitting your in-app purchases with your app for review. If an app has not previously had in-app purchases approved on the App Store, an option to submit them will appear on the main app version page.
3131

32-
![Don't forget to submit the products with the first version of your app containing in-app purchases](/images/bec1d0d-Screen_Shot_2020-06-10_at_1.17.23_PM_8f4db18fe1b912cc1a280b4cd38d312a.png)
32+
![Don't forget to submit the products with the first version of your app containing in-app purchases](/docs_images/test/prepare-for-submission.png)
3333

3434
To see this option, you must first fill in all required metadata so that the status of any in-app purchases you intend to use is 'Ready to Submit'.
3535

36-
![Make sure any in-app purchases you intend to use are "Ready to Submit".](/images/e823df0-Screen_Shot_2020-06-10_at_1.33.58_PM_c6fc553eec504b954af7d7aa9bc41f64.png)
36+
![Make sure any in-app purchases you intend to use are "Ready to Submit".](/docs_images/test/ready-to-submit.png)
3737

3838
If you've already released a version of your app containing in-app purchases, you can create new products in App Store Connect without having to release an update to your app. You'll have to submit new products for review independently of a new app version, and they must be in the 'Approved' state before they'll be available for purchase.
3939

docs/test-and-launch/debugging.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ RevenueCat's iOS 4.22.0+ and Android 6.9.2+ SDKs provide an overlay for your app
7373

7474
### iOS / macOS / visionOS
7575

76-
![RevenueCat iOS Debug UI](/images/03f4de1-simulator_screenshot_0e51e44b-dd33-41f6-9c26-ca3bed754b34_0235da821e92e90749f4f8dc0a20e68d.png)
76+
![RevenueCat iOS Debug UI](/docs_images/test/rc-debug-ui.png)
7777

7878
import db10 from "@site/code_blocks/test-and-launch/debugging_9.swift?raw";
7979
import db11 from "@site/code_blocks/test-and-launch/debugging_10.swift?raw";
@@ -99,7 +99,7 @@ Note: The debug UI won't compile for release builds, so you'll need to disable t
9999

100100
### Android
101101

102-
![RevenueCat Android Debug UI](/images/108f3d64-revenuecat-android-debug-ui-96d1-4bd7-b926-70c6676931be.png)
102+
![RevenueCat Android Debug UI](/docs_images/test/rc-debug-ui-android.png)
103103

104104
In order to use the overlay, you need to include the debug view library which is available on Maven and can be included via Gradle. Currently, this is only available as a Jetpack Compose Composable.
105105

docs/test-and-launch/debugging/caching.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ RevenueCat caches data in several places to improve performance. This includes t
1111

1212
In the Overview, the data is usually not cached and these subscription metrics will be updated in real-time. New Customer and Active Users may be cached for 1-2 hours. For some larger customers, subscription metrics may be cached for 1-2 hours as well.
1313

14-
![Image](/images/94582cb-small-Untitled_6eb7b42e862b4209a89f45670e24e3a3.png)
14+
![Image](/docs_images/test/overview-data-cache.png)
1515

1616
In each metric, you can hover over the circle icon in the bottom right corner of the card to see how recently the data within that card has been updated.
1717

0 commit comments

Comments
 (0)