[skip ci] docs

This commit is contained in:
ehesp
2019-04-09 17:52:20 +01:00
parent 20883416fd
commit 3bab1e2a4b
3 changed files with 94 additions and 0 deletions

70
docs/perf/index.md Normal file
View File

@@ -0,0 +1,70 @@
---
title: Performance Monitoring
description: Firebase Performance Monitoring is a service that helps you to gain insight into the performance characteristics of your iOS and Android apps.
---
# Cloud Functions
React Native Firebase provides native integration with Performance Monitoring to gain insight into
key performance characteristics within your React Native application. The library works out of the box,
however provides a simple API to track custom trace and HTTP request metrics.
<Youtube id="0EHSPFvH7vk" />
## Install
To get started, install the module on your platform:
<Grid columns="2">
<Block
title="Android"
to="/{{ version }}/perf/installation#android"
>
Follow the Android installation guide.
</Block>
<Block
title="iOS"
to="/{{ version }}/perf/installation#ios"
>
Follow the iOS installation guide.
</Block>
</Grid>
## Getting Started
<Grid>
<Block
icon="build"
color="#ffc107"
title="Quick Start"
to="/{{ version }}/functions/quick-start"
>
Start tracking key performance metrics within your application.
</Block>
<Block
icon="school"
color="#4CAF50"
title="Guides"
to="/guides?tag=perf"
>
Our guides walk you through some of the ways Performance Monitoring can be to gain deeper insight into your applications
performance.
</Block>
<Block
icon="layers"
color="#03A9F4"
title="Reference"
to="/{{ version }}/perf/reference"
>
The API reference covers everything required to successfully monitor your apps performance.
</Block>
</Grid>
## Learn more
Our documentation is a great place to start, however if you're looking for more help or want to help others,
check out the resources below:
- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase-perf)
- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+sort%3Aupdated-desc+label%3Aperf+)
- [Firebase Documentation](https://firebase.google.com/docs/perf-mon?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=perf-mon)

View File

@@ -0,0 +1,9 @@
---
title: Installation
description: Installing Firebase Performance Monitoring for Android & iOS
---
# Installation
TODO

15
docs/perf/quick-start.md Normal file
View File

@@ -0,0 +1,15 @@
---
title: Quick Start
description: Get to grips with the basics of Performance Monitoring in React Native Firebase
---
# Performance Monitoring Quick Start
## Module usage
TODO
## Custom Tracing
## HTTP Request Tracing