-
Notifications
You must be signed in to change notification settings - Fork 58
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
Documentation: Update README.md with Note about Android Studio/Xcode #3063
Conversation
This commit add a reference to React Native's documentation, which details configurations that are needed in Android Studio and Xcode in order for the demo apps to run.
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 good! 💯 Thanks for adding clarity to the setup documentation. I offered one small suggestion related to punctuation.
Finish incomplete sentence referencing React Native's documentation.
Wanna run full suite of Android and iOS UI tests? Click here and 'Approve' CI job! |
Thanks for the PR Siobhan! I think it will be useful for others (as well as our future selves) to know what were the issues you did encounter the the now added documentation solves. Do you think we could add some brief descriptions of the issues and what helped fixing them, either in the PR description here or in the original GitHub ticket? We could also assess how "popular" those issues can be and actually go ahead and mention them in the README directly, in the Troubleshooting section for example. |
Add some extra details to the troubleshooting section around ensuring the correct settings have been set up in the developer's environment.
@hypest, sure! I don't recall all of the errors but, with Android Studio, the emulator didn't originally work because I hadn't added the needed lines to my
With Xcode, there was some kind of conflict with the way Ruby's installed on my machine. I kept getting the following error and this guide helped me:
React Native's documentation is pretty comprehensive when it comes to how both Android Studio and Xcode should be set up, so I suspect being pointed towards it would have been enough for me to avoid the above errors. I ended up wading through a sea of StackOverflow posts when, in fact, the documentation had everything I needed, I just wasn't aware of it. I've added some extra details to the troubleshooting section, let me know what you think! |
and
Ah, I see. Yeah, unfortunately, there's no "single" way to setup things (one could use the Oracle provided JDK for example, not the OpenJDK from homebrew on Macos), and it one way or the other might conflict with WPAndroid's setup. I feel like being too prescriptive might do harm so, these kind of errors are probably best be left out of the "requirements" for gutenberg-mobile. That said, hinting about things in the Troubleshooting section is fair and helpful. |
Updating text in troubleshooting section to be a bit more specific to the scenario described.
Looks good to me at this stage! I took the liberty to re-trigger the failed CI jobs as those seemed like flakiness fails. I'll LGTM when they get green! |
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.
LGTM!
All green, reviews are 👍, and since there's no assignee set to govern who merges, I'll go ahead and merge at this point (internal ref p9ugOq-Kc-p2). |
Excellent, thank you! :) |
This PR updates the README.md with a reference to React Native's documentation, which details configurations that are needed in Android Studio and Xcode in order for the demo apps to run.
Fixes #3062
PR submission checklist: