docs: added FAQs and Tips page (#3524)

Co-authored-by: Mike Hardy <github@mikehardy.net>
Co-authored-by: Mike Diarmid <mike.diarmid@gmail.com>
This commit is contained in:
Anderson Addo
2020-06-26 12:38:00 -04:00
committed by GitHub
parent ab0f5aa514
commit 85047b6c22
5 changed files with 30 additions and 4 deletions

View File

@@ -1,7 +1,7 @@
---
name: ⚠️ Bug/Issue report - React Native
about: Please provide as much detail as possible to help us with a bug or issue. Issues
are likely to be closed and locked if they do not follow the template.
are likely to be closed and locked if they do not follow the template. Also note that v5 of react-native-firebase has been deprecated, so issues or bugs related to that version are unlikely to get attention.
---
<!---

24
docs/faqs-and-tips.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: FAQs and Tips
description: Learn about top tips from and common problems faced by the React Native Firebase community.
next: /releases
previous: /migrating-to-v6
---
Over the years, theres been a lot of discussions on our [GitHub]( https://github.com/invertase/react-native-firebase) and [Discord]( https://invertase.link/discord). Many of them have been about common problems developers face when using our package, and some of them resulted in very good advice being given.
In order to save others time and frustration, this page has been created to document some of these common problems and good pieces of advice.
If you come across a discussion that results in great advice that can benefit many developers, or a discussion that resolves a problem that many developers encounter, please do add it here! Someone will definitely be grateful.
# FAQs
### I need help with [anything regarding v5 of react-native-firebase]. Where could I get help with that?
RNFB v5 is now deprecated and unsupported. There's been over a year's grace period provided to migrate to v6, so moving forward maintainers probably won't pay much attention to issues regarding v5. Understandably, upgrading to v6 can take effort, but staying on v5 probably isn't a great choice for the long-term health of your project.
Lots of the breaking changes that were introduced were either due to upstream deprecations in the official SDKs, or to simply make the package more stable and more representative of how the actual SDKs work.
The longer you stay on v5, the more your project will be out of sync with the official SDKs, unfortunately. Couple that with the fact that it's no longer actively supported, and that's trouble looming over the horizon for your project.
We highly recommend taking the necessary pains to update to v6.
# Tips
- Advice on supporting multiple environments (for example, dev, prod, maybe also staging, qa) for your React Native Firebase App: [#3504]( https://github.com/invertase/react-native-firebase/issues/3504)

View File

@@ -1,7 +1,7 @@
---
title: Migrating to v6
description: Migrate to React Native Firebase v6
next: /admob/usage
next: /faqs-and-tips
previous: /releases
---

View File

@@ -1,8 +1,8 @@
---
title: Release notes
description: View the latest release notes for React Native Firebase
next: /migrating-to-v6
previous: /typescript
next: /typescript
previous: /migrating-to-v6
---
Starting with version `v6.5.0`; all React Native Firebase packages are now independently versioned with individually generated release notes:

View File

@@ -7,6 +7,8 @@
- '/releases'
- - Migrating to v6
- '/migrating-to-v6'
- - FAQs and Tips
- '/faqs-and-tips'
- - Feature Requests
- 'https://invertase.canny.io/react-native-firebase'
- - Contributing