-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Updated Expo installation steps #5548
Conversation
This pull request is being automatically deployed with Vercel (learn more). react-native-firebase – ./🔍 Inspect: https://vercel.com/invertase/react-native-firebase/DpY7Z7AuLGtmmwhi3SRgExtza9ES react-native-firebase-next – ./website_modular🔍 Inspect: https://vercel.com/invertase/react-native-firebase-next/JBhXTq8h7HPj8ZCEoTM6kY9kVjmF [Deployment for 0ece732 canceled] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a great start @barthap thank you!
I have a very sensitive sense of fear around documentation either going out of date or not being complete enough to forestall future issues traffic in line with my desire for "zero maintenance by design".
In this case I fear link rot scattered on multiple pages, and I love the example in the app package expo section but fear there is no example in the non-app sections, along with the vague wording about modules needing config plugins or not based on whether they need native adjustements or not
I think all three may be resolved by:
- simply (with no links) referencing the app expo section in all non-app install docs
- in the app expo section expanding the example by saying "An integration that included the optional crashlytics and performance as well as the mandatory app plugin would look like this, customize based on which optional modules you use..." then showing them all
- maintaining the vague-ness about which modules may need config plugins but giving the user the information needed to help themselves via some sort of verbiage like "you may see if a module needs a config plugin by checking <what? I think whether there is AndroidManifest.xml/Info.plist manipulation which is detectable by looking at the apps init code which is regular and thus explainable?> and you may see if a config plugin has been implemented already by checking <description of where the plugins live in each module with link to crashlytics or perf as an example?>" ?
That will keep all the link we don't control and config JSON format we don't control in one spot so we won't forget some other spot when config plugins v2.0 comes out, and if some user decides to try expo + random-RNFB-module right before everyone here is offline for a few days they can still sort it out for themselves pretty efficiently whether it's necessary + possible
What do you think?
Thank you for the suggestions, I mostly agree with them. Honestly, I was struggling with the right wording and deciding about right places for each information. Now my vision is updated 😃 and I'll think of some improvements:
|
Each of your ideas in each bullet point seem right on target. I do like the idea of recommending tools but always remember vi still lives and some people (like myself) explore repos via octotree in the browser just surfing a directory tree, so keep tool recommendations always as an optional suggestion and make sure the main path allows deduction from file paths alone |
Ok, I made a try to address all the suggestions (updated the screenshot in PR description). It was harder than I expected though. As I'm familiar with Expo, some things seem obvious to me and was not sure how to explain. As I'm not a native English speaker, my wording and grammar may not be 100% correct, please correct me if you find any mistakes 😃 Btw. thanks for mentioning octotree! It's awesome - until now, when I didn't have a repo cloned and open in VSCode, I used to browse files just with GitHub 😶 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@barthap I think this is great, any little worries I had are thoroughly addressed I think. As a tangent - for anyone that hints at a lack of confidence in their English I'm pretty quick to give support since I myself moved to a country that speaks something other than my native language a few years back. It is not easy! Especially in your case your English is fantastic despite English being basically horrible to write in since everything is an exception. I couldn't see anything that seemed off, everything appeared to be natural / idiomatic English to me. Job well done.
I'm gearing up for a release of RNFB in the next day or so, so all this hard work will see the light of day shortly. Thanks!
Description
Follow-up of #5480, answer to the #5480 (comment)
Updated documentation about Expo installation steps. I'm not sure how it should look like to be maximum simple and user-friendly. This is how it currently looks like (click to enlarge):
Updated sections:
Related issues
Release Summary
Checklist
Android
iOS
e2e
tests added or updated inpackages/\*\*/e2e
jest
tests added or updated inpackages/\*\*/__tests__
Test Plan
yarn lint:spellcheck
,yarn lint:markdown
.yarn develop
).Think
react-native-firebase
is great? Please consider supporting the project with any of the below:React Native Firebase
andInvertase
on Twitter