forked from Amplitude-Developer-Docs/amplitude-dev-center
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
384 lines (370 loc) · 13.9 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# Project information
site_name: Amplitude Developer Center
site_url: https://docs.developers.amplitude.com
site_author: Amplitude
site_description: >-
Developer resources for Amplitude's digital optimization products.
# Repository
repo_name: amplitude-dev-center
repo_url: https://github.com/Amplitude-Developer-Docs/amplitude-dev-center
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2022 Amplitude - <a href="#__consent">Change cookie settings</a>
# Configuration
theme:
name: material
custom_dir: overrides
icon:
repo: fontawesome/brands/github
# Static files
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
#- announce.dismiss # this feature is perenially buggy, so keep it disabled unless necessary.
- content.code.annotate
- content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.instant
- navigation.indexes
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
# - toc.integrate #this is a really noisy feature, IMO.
font: false # Prevents autoloading of google fonts, for privacy reasons.
favicon: assets/favicon.ico
logo: assets/logo.png
extra_css:
- stylesheets/extra.css
extra_javascript:
- /javascripts/accessibe.js # Script for Accessibe. Don't remove without speaking to Legal
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- /javascripts/tablesort.js #script for Tablesort feature
# Plugins
# When you add a plugin here, make sure the change is updated in insiders.mkdocs.yml too.
plugins:
- search
- git-revision-date
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
use_pygments: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.snippets
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra:
support_contact: https://amplitude.com
community: https://community.amplitude.com
help_site: https://help.amplitude.com
training_site: https://academy.amplitude.com/
postman_workspace: https://www.postman.com/amplitude-developer-docs/workspace/amplitude-developers/overview
report_issue: https://github.com/Amplitude-Developer-Docs/amplitude-dev-center/issues/new/?title=[Feedback]+{{page.title}}+-+{{page.url}}
getting_started_guide: https://docs.developers.amplitude.com/getting-started
more_resources: all-resources
status:
new: Recently added
deprecated: Deprecated
analytics:
provider: amplitude
consent:
cookies:
analytics: Amplitude Analytics
actions:
- accept
- manage
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
generator: false #hides the generated with text in the footer
# Navigation
nav:
- Analytics:
- analytics/index.md
- Overview: analytics/index.md
- What is Amplitude?: analytics/what-is-amplitude.md
- Find Your API Credentials: analytics/find-api-credentials.md
- SDKs:
- SDK Catalog: data/sources/#sdks
- API References:
- Attribution: analytics/apis/attribution-api.md
- Batch Event Upload: analytics/apis/batch-event-upload-api.md
- Behavioral Cohorts: analytics/apis/behavioral-cohorts-api.md
- CCPA DSAR: analytics/apis/ccpa-dsar-api.md
- Chart Annotations: analytics/apis/chart-annotations-api.md
- Dashboard: analytics/apis/dashboard-rest-api.md
- Export: analytics/apis/export-api.md
- Group Identify: analytics/apis/group-identify-api.md
- HTTP V2: analytics/apis/http-v2-api.md
- Identify: analytics/apis/identify-api.md
- Lookup Tables: analytics/apis/lookup-tables-api.md
- Releases: analytics/apis/releases-api.md
- SCIM: analytics/apis/scim-api.md
- Taxonomy: analytics/apis/taxonomy-api.md
- User Privacy: analytics/apis/user-privacy-api.md
- User Profile: analytics/apis/user-profile-api.md
- Advanced Topics:
- analytics/data-backfill-guide.md
- Custom Domain Proxy: analytics/domain-proxy.md
- Experiment:
- experiment/index.md
- Overview: experiment/index.md
- General:
- experiment/general/data-model.md
- Evaluation:
- Implementation: experiment/general/evaluation/implementation.md
- experiment/general/evaluation/remote-evaluation.md
- Local Evaluation: experiment/general/evaluation/local-evaluation.md
- experiment/general/performance-and-caching.md
- experiment/general/exposure-tracking.md
- Guides:
- Getting Started:
- experiment/guides/getting-started/create-a-deployment.md
- experiment/guides/getting-started/create-a-flag.md
- experiment/guides/getting-started/fetch-variants.md
- experiment/guides/getting-started/track-exposure.md
- experiment/guides/server-side-rendering.md
- experiment/guides/create-local-evaluation-flag.md
- SDKs:
- JavaScript SDK: experiment/sdks/javascript-sdk.md
- Android SDK: experiment/sdks/android-sdk.md
- iOS SDK: experiment/sdks/ios-sdk.md
- React Native SDK (Beta): experiment/sdks/react-native-sdk.md
- Node.js SDK: experiment/sdks/nodejs-sdk.md
- JVM SDK (Beta): experiment/sdks/jvm-sdk.md
- Go SDK (Beta): experiment/sdks/go-sdk.md
- Ruby SDK (Beta): experiment/sdks/ruby-sdk.md
- Python SDK (Beta): experiment/sdks/python-sdk.md
- Legacy:
- React Native SDK: experiment/sdks/react-native-sdk-legacy.md
- REST APIs:
- Evaluation API: experiment/apis/evaluation-api.md
- Management API (Beta): experiment/apis/management-api.md
- Data:
- data/index.md
- Overview: data/index.md
- Getting Started: "getting-started.md"
- Debugging Analytics: "data/debugger.md"
- Sources:
- Overview: data/sources.md
- Ampli:
- data/ampli/index.md
- data/ampli/cli.md
- data/ampli/sdk.md
- data/ampli/integrating-with-ci.md
- Source Control: data/ampli/git-workflow.md
- data/ampli/middleware.md
- data/ampli/plugin.md
- data/ampli/migration.md
- SDKs:
- Browser:
- data/sdks/typescript-browser/index.md
- data/sdks/typescript-browser/migration.md
- Ampli Codegen: data/sdks/typescript-browser/ampli.md
- Node.js (Beta):
- data/sdks/typescript-node/index.md
- Android:
- data/sdks/android-kotlin/index.md
- Ampli Codegen: data/sdks/android-kotlin/ampli.md
- iOS:
- data/sdks/ios/index.md
- Ampli Codegen: data/sdks/ios/ampli.md
- Java:
- data/sdks/java/index.md
- Ampli Codegen: data/sdks/java/ampli.md
- React Native (Beta):
- data/sdks/typescript-react-native/index.md
- Flutter:
- data/sdks/flutter/index.md
- Python:
- data/sdks/python/index.md
- Ampli Codegen: data/sdks/python/ampli.md
- Unity:
- data/sdks/unity/index.md
- Unreal:
- data/sdks/unreal/index.md
- GO:
- data/sdks/go/index.md
- Legacy:
- Browser:
- data/sdks/javascript/index.md
- Ampli Codegen: data/sdks/javascript/ampli.md
- Android:
- data/sdks/android/index.md
- Ampli Codegen: data/sdks/android/ampli.md
- React Native:
- data/sdks/react-native/index.md
- Ampli Codegen: data/sdks/react-native/ampli.md
- Node.js:
- data/sdks/node/index.md
- Ampli Codegen: data/sdks/node/ampli.md
- Other Topics:
- data/dynamic-configuration.md
- Cloud Storage:
- Amazon S3: data/sources/amazon-s3.md
- Google Cloud Storage: data/sources/google-cloud-storage.md
- Converter Configuration: data/converter-configuration-reference.md
- Warehouse:
- BigQuery: data/sources/bigquery.md
- Snowflake: data/sources/snowflake.md
- Other Sources:
- Adjust: data/sources/adjust.md
- Adobe:
- Adobe Analytics: data/sources/adobe-analytics.md
- Adobe Tag Manager: data/sources/adobe.md
- Airbridge: data/sources/airbridge.md
- Apphud: data/sources/apphud.md
- AppsFlyer: data/sources/appsflyer.md
- Branch: data/sources/branch.md
- Braze: data/sources/braze.md
- Census: data/sources/census.md
- CleverTap: data/sources/clevertap.md
- Convizit: data/sources/convizit.md
- CSV: data/sources/lookup-table.md
- Datazoom: data/sources/datazoom.md
- Facebook Ads: data/sources/facebook-ads.md
- Google Ads: data/sources/google-ads.md
- Google Tag Manager: data/sources/google-tag-manager.md
- Hightouch: data/sources/hightouch.md
- HubSpot: data/sources/hubspot.md
- Intercom: data/sources/intercom.md
- Iterable: data/sources/iterable.md
- Kochava: data/sources/kochava.md
- Leanplum: data/sources/leanplum.md
- Mailchimp: data/sources/mailchimp.md
- mParticle: data/sources/mparticle.md
- OneSignal: data/sources/onesignal.md
- Optimizely: data/sources/optimizely.md
- Qualtrics: data/sources/qualtrics.md
- Radar: data/sources/radar.md
- RevenueCat: data/sources/revenuecat.md
- Rudderstack: data/sources/rudderstack.md
- Salesforce: data/sources/salesforce-group.md
- Segment: data/sources/segment.md
- SendGrid: data/sources/sendgrid.md
- Shopify: data/sources/shopify.md
- Split: data/sources/split.md
- Singular: data/sources/singular.md
- Survicate: data/sources/survicate.md
- Taplytics: data/sources/taplytics.md
- Tribe: data/sources/tribe.md
- Userflow: data/sources/userflow.md
- Destinations:
- Overview: data/destinations.md
- Cloud Storage:
- Amazon S3: data/destinations/amazon-s3.md
- Google Cloud Storage: data/destinations/google-cloud-storage.md
- Warehouse:
- Redshift: data/destinations/redshift.md
- BigQuery: data/destinations/bigquery.md
- Snowflake: data/destinations/snowflake.md
- Event Streaming:
- AppsFlyer: data/destinations/appsflyer.md
- Braze: data/destinations/braze.md
- Customer.io: data/destinations/customerio.md
- Pub/Sub: data/destinations/google-pub-sub.md
- Google Analytics 4: data/destinations/google-analytics-4.md
- Intercom: data/destinations/intercom.md
- Iterable: data/destinations/iterable.md
- Kinesis: data/destinations/kinesis-data-stream.md
- Kinesis Firehose: data/destinations/kinesis-firehose.md
- Meta Pixel: data/destinations/meta-pixel.md
- Cohorts:
- Airship: data/destinations/airship-cohort.md
- Amazon S3: data/destinations/amazon-s3-cohort.md
- Appcues: data/destinations/appcues-cohort.md
- AppsFlyer: data/destinations/appsflyer-cohort.md
- Braze: data/destinations/braze-cohort.md
- Cordial: data/destinations/cordial-cohort.md
- Customer.io: data/destinations/customerio-cohort.md
- Enterpret: data/destinations/enterpret-cohort.md
- Facebook Ads: data/destinations/facebook-cohort.md
- Google Ads: data/destinations/google-ads-cohort.md
- HubSpot: data/destinations/hubspot-cohort.md
- Infobip: data/destinations/infobip-cohort.md
- Intercom: data/destinations/intercom-cohort.md
- Insider: data/destinations/insider-cohort.md
- Iterable: data/destinations/iterable-cohort.md
- Klaviyo: data/destinations/klaviyo-cohort.md
- LaunchDarkly: data/destinations/launchdarkly-cohort.md
- Leanplum: data/destinations/leanplum-cohort.md
- Mailchimp: data/destinations/mailchimp-cohort.md
- Marketo: data/destinations/marketo-cohort.md
- MoEngage: data/destinations/moengage-cohort.md
- Netcore Cloud: data/destinations/netcore-cohort.md
- Notivize: data/destinations/notivize-cohort.md
- OneSignal: data/destinations/onesignal-cohort.md
- Productboard: data/destinations/productboard-cohort.md
- Qualtrics: data/destinations/qualtrics-cohort.md
- Salesforce Marketing Cloud: data/destinations/marketing-cloud-cohort.md
- Split: data/destinations/split-cohort.md
- Segment: data/destinations/segment-cohort.md
- Statsig: data/destinations/statsig-cohort.md
- TikTok: data/destinations/tiktok-cohort.md
- Userflow: data/destinations/userflow-cohort.md
- Partners:
- partners/index.md
- Overview: partners/index.md
- partners/sending-cohorts.md
- Resources:
- all-resources.md
# Files Intentionally left out of nav:
#- Data Docs (Deprecated): These are excluded on purpose please don't add them to nav
#- data/deprecated-sdks/browser.md
#- data/deprecated-sdks/nodejs.md
#- data/deprecated-sdks/ios.md
#- data/deprecated-sdks/android.md
#- data/deprecated-sdks/jre.md
#- data/deprecated-sdks/python.md
#- data/deprecated-sdks/ruby.md
#- data/deprecated-sdks/dotnet.md
#- data/deprecated-sdks/jre-v3.md
#- data/deprecated-sdks/ruby-v2.md
#- data/iglu-api.md