Commit Graph

7 Commits

Author SHA1 Message Date
Héctor Ramos 8324e92f76 Streamline Getting Started Instructions
Summary:
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.

* The original section title, "Required prerequisites", is redundant. "Installing React Native" is a better description of what this section is about.
* Detailed installation instructions for each of the required tools are delegated to the first party instructions where available.
* 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.

* 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.
* Link to Node.js package manager instructions and let savvy Linux users use the pack
Closes https://github.com/facebook/react-native/pull/8010

Differential Revision: D3407029

Pulled By: JoelMarcey

fbshipit-source-id: c8b25d5b176c40eb58e5d7d3c6f13d43cde65166
2016-06-08 13:28:34 -07:00
Kishan Patel 7cd8591734 Fixed Typo: "Termimal" => "Terminal"
Summary:
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:

(You can skip this if you're fixing a typo or adding an app to the Showcase.)

Explain the **motivation** for making this change. What existing problem does the pull request solve?

Prefer **small pull requests**. These are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.

**Test plan (required)**

Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.

Make sure tests pass on both Travis and Circle CI.

**Code formatting**

Look around. Match the style of the rest of the codebase. See also the simple [style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide).

For more info, see the ["Pull Requests" section of our "Contributing" guidelines](https://github.com/facebook/react-native/blob/mas
Closes https://github.com/facebook/react-native/pull/7951

Differential Revision: D3394509

Pulled By: JoelMarcey

fbshipit-source-id: 0ae23950c69ae06a4b85d2e4b577a71e9aa2b7f4
2016-06-06 14:28:26 -07:00
kiran 3f2f773388 Mentioned Google emulator instead of genymotion
Summary: Closes https://github.com/facebook/react-native/pull/7793

Differential Revision: D3358150

fbshipit-source-id: 881ea80dfc9cfd28337995a8648f14c51b468b0a
2016-05-27 04:58:29 -07:00
Joel Marcey 14dd3845c9 Make Getting Started labels a bit more clear
Summary:
"Target" over "Platform" to represent target for your RN app
"Development OS" over "OS" to represent your RN Development environment

<img width="526" alt="screenshot 2016-05-21 09 48 47" src="https://cloud.githubusercontent.com/assets/3757713/15449679/87e1c9fa-1f39-11e6-99e9-822c2022c4db.png">
Closes https://github.com/facebook/react-native/pull/7674

Differential Revision: D3332780

fbshipit-source-id: b0acfc843e00a9bd71b940c5f51507667ba5123e
2016-05-21 11:43:25 -07:00
Joel Marcey 97f803bc2e Add information about verifying Xcode Command Line Tools are installed
Summary:
<img width="694" alt="screen shot 2016-05-19 at 10 12 35 am" src="https://cloud.githubusercontent.com/assets/3757713/15402657/3f9a5896-1daa-11e6-842d-7a6c57b86b9f.png">
Closes https://github.com/facebook/react-native/pull/7637

Differential Revision: D3332705

Pulled By: JoelMarcey

fbshipit-source-id: a01b98305fe1b11559e7c9893e7844cb37599fc4
2016-05-21 09:58:25 -07:00
Joel Marcey 18e1b1f197 Best effort selection of target platform and dev environment
Summary:
Right now, if you do a search and select a document in Getting Started, it will
always default to iOS/Mac. This adds a bit of JavaScript to do a best effort
selection based on the hashtags of the headers.

If a header is associated with multiple environments (e.g., Android Studio), we
just choose the first one. So it is not 100% perfect, but it is decent.

ref: https://github.com/facebook/react-native/issues/7574

** Test Plan **

Test locally by adding hash tags to the end of a doc URL and ensured that the toggler had the right
selection.

e.g., `http://localhost:8079/react-native/docs/getting-started.html#chocolatey` had `Android` and `Windows` chosen.
Closes https://github.com/facebook/react-native/pull/7608

Differential Revision: D3316802

Pulled By: JoelMarcey

fbshipit-source-id: 6e94d76725fb97b19b3708ddee8fba5df9350cdd
2016-05-18 09:13:24 -07:00
Joel Marcey 17be4c754e Core components tutorial
Summary:
Create the initial Core Components tutorial. The core components are `Text`, `Image`, `View`, `TextInput`, `ListView`.

1. Provide a summary for each core component, including a runnable sample.
2. Allow the tutorials for each component to be extended with more details and detailed examples, particularly after we add other tutorials (i.e., around state and props).
3. The samples should be runnable in a React Native simulator, if we can get that going in the docs.
4. Reorganize the docs sidebar to make the current Tutorial actually a Sample App, etc.
Closes https://github.com/facebook/react-native/pull/7593

Differential Revision: D3313563

Pulled By: JoelMarcey

fbshipit-source-id: cfe1d397d60822b8c531405d66b4e73694c7dbf9
2016-05-17 18:28:23 -07:00