{"action":"created","issue":{"url":"https://api.github.com/repos/facebook/react-native/issues/8010","repository_url":"https://api.github.com/repos/facebook/react-native","labels_url":"https://api.github.com/repos/facebook/react-native/issues/8010/labels{/name}","comments_url":"https://api.github.com/repos/facebook/react-native/issues/8010/comments","events_url":"https://api.github.com/repos/facebook/react-native/issues/8010/events","html_url":"https://github.com/facebook/react-native/pull/8010","id":159210994,"number":8010,"title":"[website] Streamline Getting Started Instructions","user":{"login":"hramos","id":165856,"avatar_url":"https://avatars.githubusercontent.com/u/165856?v=3","gravatar_id":"","url":"https://api.github.com/users/hramos","html_url":"https://github.com/hramos","followers_url":"https://api.github.com/users/hramos/followers","following_url":"https://api.github.com/users/hramos/following{/other_user}","gists_url":"https://api.github.com/users/hramos/gists{/gist_id}","starred_url":"https://api.github.com/users/hramos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hramos/subscriptions","organizations_url":"https://api.github.com/users/hramos/orgs","repos_url":"https://api.github.com/users/hramos/repos","events_url":"https://api.github.com/users/hramos/events{/privacy}","received_events_url":"https://api.github.com/users/hramos/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/facebook/react-native/labels/CLA%20Signed","name":"CLA Signed","color":"e7e7e7"},{"url":"https://api.github.com/repos/facebook/react-native/labels/GH%20Review:%20review-needed","name":"GH Review: review-needed","color":"fbca04"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2016-06-08T16:29:48Z","updated_at":"2016-06-08T19:12:45Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/facebook/react-native/pulls/8010","html_url":"https://github.com/facebook/react-native/pull/8010","diff_url":"https://github.com/facebook/react-native/pull/8010.diff","patch_url":"https://github.com/facebook/react-native/pull/8010.patch"},"body":"The Getting Started guide is one of the first documents a new user will encounter. This pull request aims to minimize the amount of time it takes to get a React Native app up and running.\r\n\r\n### Installing React Native\r\n* The original section title, \"Required prerequisites\", is redundant. \"Installing React Native\" is a better description of what this section is about.\r\n* Detailed installation instructions for each of the required tools are delegated to the first party instructions where available.\r\n* If the installation instructions already take care of installing the latest version, there's no need to warn the user about the minimum required version.\r\n\r\n### Recommending the use of package managers\r\n* Assume the user is familiar with Homebrew or Chocolatey, and defer installation instructions to the package manager's website. The installation and explanation of what a package manager is is out of scope within this document.\r\n* Link to Node.js package manager instructions and let savvy Linux users use the package manager native to their distro, instead of installing from NodeSource.\r\n\r\n### Remove optional installs, and double down on highly recommended installs\r\n* Optional installs distract the user from the goal, and have been removed.\r\n* Flow and Nuclide are not required to use React Native, and have been removed from the Getting Started guide. Learning about static type checkers and a new IDE at the same time the user is picking up React Native can distract the user.\r\n* Watchman is not necessarily required, but is extensively used within Facebook. If we think it is highly recommended to install it, then we should straight up tell the user to install it.\r\n\r\n### Android Emulators\r\n* Instructions about using Genymotion and other emulators have been removed when the text is not referring to an issue that is unique to React Native development.\r\n\r\n### Debugging and Troubleshooting\r\n* Troubleshooting tips have been moved out of the Getting Started and into the existing Troubleshooting doc that is already linked at the end of the guide. Focus on a great experience, and allow the user to dig deeper if and only if they run into trouble.\r\n* Update Debugging and Troubleshooting tips to be consistent with its references to the Developer Menu and the various keyboard shortcuts.\r\n* RedBoxes and YellowBoxes are one of the first things a user will encounter when their app has an error. Document these at the top.\r\n* Reloading JavaScript and Live Reload can be documented together.\r\n* When instructions for iOS and Android are provided, do not use an ordered list. Assume the user is interested in one platform or the other, in no specific order.\r\n\r\n# Test plan\r\n\r\nWebsite was generated locally and verified on Chrome v51.0.2704.84 OS X, Safari Version 9.1.1 (11601.6.17) OS X. The scope of the pull request is limited to copy changes and therefore testing on additional browsers is deemed unnecessary.\r\n\r\n***Steps to generate website***\r\n```\r\ncd website\r\nnpm install\r\nnpm start\r\nopen http://localhost:8079/react-native/docs/getting-started.html\r\nopen http://localhost:8079/react-native/docs/debugging.html\r\nopen http://localhost:8079/react-native/docs/troubleshooting.html\r\n```\r\n\r\n## Screenshots of updated documentation by platform\r\n\r\n### Getting Started: iOS on Mac\r\n![gettingstarted-ios-mac](https://cloud.githubusercontent.com/assets/165856/15900282/cea6bb34-2d53-11e6-9224-5c82e05fcd6c.png)\r\n\r\n### Getting Started: Android on Mac\r\n![gettingstarted-android-mac](https://cloud.githubusercontent.com/assets/165856/15900287/d26acf44-2d53-11e6-958a-0effe0302010.png)\r\n\r\n### Getting Started: Android on Linux\r\n\r\n![gettingstarted-android-linux](https://cloud.githubusercontent.com/assets/165856/15900289/d4205a7a-2d53-11e6-926b-52978fa66a5e.png)\r\n\r\n### Getting Started: Android on OS X\r\n\r\n![gettingstarted-android-osx](https://cloud.githubusercontent.com/assets/165856/15900293/d6828b8a-2d53-11e6-96da-612fb080e1b3.png)\r\n\r\n### Getting Started: Android on Windows\r\n\r\n![gettingstarted-android-windows](https://cloud.githubusercontent.com/assets/165856/15900454/71ca8462-2d54-11e6-82fe-00645941804e.png)\r\n\r\n### Debugging\r\n\r\n![debugging](https://cloud.githubusercontent.com/assets/165856/15902347/4be5b372-2d5c-11e6-9a1d-0e323266feb7.png)\r\n\r\n### Troubleshooting\r\n\r\n![troubleshooting](https://cloud.githubusercontent.com/assets/165856/15902353/5043aa00-2d5c-11e6-813d-616a484aa51a.png)\r\n"},"comment":{"url":"https://api.github.com/repos/facebook/react-native/issues/comments/224697089","html_url":"https://github.com/facebook/react-native/pull/8010#issuecomment-224697089","issue_url":"https://api.github.com/repos/facebook/react-native/issues/8010","id":224697089,"user":{"login":"caabernathy","id":691109,"avatar_url":"https://avatars.githubusercontent.com/u/691109?v=3","gravatar_id":"","url":"https://api.github.com/users/caabernathy","html_url":"https://github.com/caabernathy","followers_url":"https://api.github.com/users/caabernathy/followers","following_url":"https://api.github.com/users/caabernathy/following{/other_user}","gists_url":"https://api.github.com/users/caabernathy/gists{/gist_id}","starred_url":"https://api.github.com/users/caabernathy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/caabernathy/subscriptions","organizations_url":"https://api.github.com/users/caabernathy/orgs","repos_url":"https://api.github.com/users/caabernathy/repos","events_url":"https://api.github.com/users/caabernathy/events{/privacy}","received_events_url":"https://api.github.com/users/caabernathy/received_events","type":"User","site_admin":false},"created_at":"2016-06-08T19:12:45Z","updated_at":"2016-06-08T19:12:45Z","body":"Looks great!"}}
{"actor":{"display_login":"caabernathy"}}