Commit Graph

49 Commits

Author SHA1 Message Date
Ville Immonen 6e99e314b2 Move HelloWorld template to a single index.js entry point
Summary:
This change (initially discussed in https://github.com/react-community/create-react-native-app/issues/26) moves the HelloWorld project template from two nearly identical entry points (`index.android.js` and `index.ios.js`) to a single, minimal `index.js` entry point. The root component is created in `App.js`. This unifies the project structure between `react-native init` and Create React Native App and allows CRNA's eject to use the entry point from the HelloWorld template without any hacks to customize it. Also examples in the docs can be just copy-pasted to `App.js` the same way in both HelloWorld and CRNA apps without having to first learn about  `AppRegistry.registerComponent`.

* Created a new project from the template using `./scripts/test-manual-e2e.sh` and verified that:
  * The app builds, starts and runs both on Android and iOS.
  * Editing and reloading changes works.
  * The new files (`index.js`, `App.js`, `__tests__/App.js`) get created in the project folder.

<img width="559" alt="screen shot 2017-08-01 at 19 10 51" src="https://user-images.githubusercontent.com/497214/28835171-300a12b6-76ed-11e7-81b2-623639c3b8f6.png">
<img width="467" alt="screen shot 2017-08-01 at 19 09 12" src="https://user-images.githubusercontent.com/497214/28835180-33d285e0-76ed-11e7-8d68-2b3bc44bf585.png">

<!--
Thank you for sending the PR!

If you changed any code, please provide us with clear instructions on how you verified your changes work. In other words, a test plan is *required*. Bonus points for screenshots and videos!

Please read the Contribution Guidelines at https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md to learn more about contributing to React Native.

Happy contributing!
-->
Closes https://github.com/facebook/react-native/pull/15312

Differential Revision: D5556276

Pulled By: hramos

fbshipit-source-id: 068fdf7e51381c2bc50321522f2be0db47296c5e
2017-08-03 14:02:43 -07:00
Hector Ramos 75eb55096e Increase text size, rename Tutorial, update nav...
Summary:
Several things here. See commits.
Closes https://github.com/facebook/react-native/pull/14757

Differential Revision: D5332034

Pulled By: hramos

fbshipit-source-id: 6ff9e33c0bc9d2ea3dd5b1a4752621ce7e83f9bb
2017-06-27 14:18:07 -07:00
Hector Ramos f42f2dff37 New Handling Touches Tutorial
Summary:
Finally, a place where `Button` is properly introduced. This is based on the old Handling Touches guide, which has been simplified (with some content moved over to the scroll views tutorial).

I've also updated the ordering of the guides into something that makes more sense to someone just getting started with React Native.
Closes https://github.com/facebook/react-native/pull/14371

Differential Revision: D5201127

Pulled By: hramos

fbshipit-source-id: 819192e2db9febb8a315f51693dae557752b6002
2017-06-07 11:51:21 -07:00
Hector Ramos b1ecb84c97 Standardize on using AwesomeProject for AppRegistry calls.
Summary:
We've noticed that many newcomers paste sample code straight into a project created using `react-native init AwesomeProject`, but the sample code assumes the user is creating a new project for each example. This PR makes it so that these samples can be pasted into the same project from the Getting Started.
Closes https://github.com/facebook/react-native/pull/14264

Differential Revision: D5149746

Pulled By: hramos

fbshipit-source-id: cae95ab5b7baf64ddd9fe12d342ad05f785bb381
2017-05-30 14:20:42 -07:00
Adam Perry ca2d57c744 Update examples in docs and address version lag of CRNA
Summary:
cc hramos

Pretty sure I've hit all of the places where AppRegistry is called in CRNA-pastable examples. Let me know whether you think we need to approach the version lag differently, I figure a caveat is as natural a place to call it out as any.

If you end up finding anything else that needs tweaking before cherry picking, I'm happy to push that up here too.
Closes https://github.com/facebook/react-native/pull/13744

Differential Revision: D5071038

Pulled By: hramos

fbshipit-source-id: 4a4a6f2a73079aca627f17d75a4e4b395ecbd4a8
2017-05-16 23:51:28 -07:00
Sandeep Ramgolam d35fef8bbb Changed registerComponent name to maintain tutorial flow.
Summary:
Changed the registerComponent name from 'HelloWolrdApp' to 'AwesomeProject' because the instructions says paste it into your index.ios.js but that doesn't actually work, unless the component is named 'AwesomeProject'.

First timers shouldn't have to deal with a big bad red screen of death. 😅
Closes https://github.com/facebook/react-native/pull/13709

Differential Revision: D5010357

Pulled By: javache

fbshipit-source-id: 101bec8e9d98fa97b3cd4a2a8e81df1f87381216
2017-05-05 12:18:04 -07:00
Paul Mestemaker 8378f0f9f7 Ensure documentation has consistent relative links
Summary:
Explain the **motivation** for making this change. What existing problem does the pull request solve?

I had tried fixing a broken link in a previous commit (#11453). My commit was merged, but it did not resolve the underlying problem. I have looked into how links should be formed for the docs and have fixed the original problem as well as updated all other links to be consistent.

Previous link formats:

- /docs/sample.html <-- broken link
- sample.html <-- broken link
- https://facebook.github.io/react-native/docs/sample.html <-- works
- /react-native/docs/sample.html <-- works
- docs/sample.html <-- works (permalink format)

This PR updates all links to the permalink format.

**Test plan (required)**
I ran the website locally and manually tested half of the links in each category. They all worked.
```
$ cd website
$ npm install && npm start
```
Closes https://github.com/facebook/react-native/pull/12064

Differential Revision: D4489153

Pulled By: mkonicek

fbshipit-source-id: bf0231d941ba147317595c3b3466dc579a887169
2017-01-31 12:13:31 -08:00
Joel Marcey b1e49832ef Make prev links work in guides and APIs.
Summary:
We had rendering support for prev links, but we never had any previous links in our metadata. Only next links. This adds that support to both Guides and APIs.

**For guides**: `previous` is manually inserted into the metadata of the actual markdown file.
**For APIs/Components**: `previous` is established via code within `extractDocs.js`

> This isn't totally perfect. For example, the transition from the last guide to the first API/component has a next link from the guide, but not a previous link from the API since the way you get the previous links are different from guides and APIs. But this gets us really close.
Closes https://github.com/facebook/react-native/pull/8754

Differential Revision: D3557972

Pulled By: hramos

fbshipit-source-id: e270bb51e7a4f59f61dad28ae0928d27d0af3d4a
2016-07-13 14:58:27 -07:00
Kevin Lacker bfb4c054f4 Make "The Basics" flow like a linear tutorial
Summary: Closes https://github.com/facebook/react-native/pull/8429

Differential Revision: D3487369

Pulled By: lacker

fbshipit-source-id: 59b32f2a2a67370192c91dc43da3d4b76a43b810
2016-06-26 12:43:25 -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
Ajdin 4791b46bf4 Removing Rotten Tomatoes API Info
Summary:Earlier on in the tutorial it was recommended to pull in mock data from Github instead of making Rotten Tomato API calls, this change will update the final code to match the rest of the tutorial.
Closes https://github.com/facebook/react-native/pull/7025

Differential Revision: D3190334

fb-gh-sync-id: e699f756d81d0436bac6a4938d54fcaada5d878c
fbshipit-source-id: e699f756d81d0436bac6a4938d54fcaada5d878c
2016-04-17 20:56:23 -07:00
Martin Konicek f2e45bcd48 Tutorial: Add a link to makeitopen.com
Summary:**Motivation**

http://makeitopen.com is such a great resource, we should link to it from the docs.

**Test plan (required)**

Ran the website locally using `cd website && npm install && npm start`:

![screen shot 2016-04-14 at 12 35 04 pm](https://cloud.githubusercontent.com/assets/346214/14526773/9517f20c-023d-11e6-9955-7ec270fffb4a.png)
Closes https://github.com/facebook/react-native/pull/6976

Differential Revision: D3178944

fb-gh-sync-id: 26a6fdb4f04f2cb51fcba229852a67f640f534cb
fbshipit-source-id: 26a6fdb4f04f2cb51fcba229852a67f640f534cb
2016-04-14 05:33:20 -07:00
sunnylqm c3824f4163 Explicitly import React
Summary:Following this commit:
a80dd9a92a
Closes https://github.com/facebook/react-native/pull/6910

Differential Revision: D3169295

fb-gh-sync-id: 8a82a7f9dd3b4af2e1cbfdac86842cd450023379
fbshipit-source-id: 8a82a7f9dd3b4af2e1cbfdac86842cd450023379
2016-04-12 12:34:23 -07:00
Nick 2a03182b1c CHORE - Remove Trailing Spaces
Summary:Remove Trailing Spaces.

Why:
Sometimes there are conflicts with trailing spaces
Saves space
Those whose tools automatically delete them will have their pr watered down with trailing space removal
Closes https://github.com/facebook/react-native/pull/6787

Differential Revision: D3144704

fb-gh-sync-id: d8a62f115a3f8a8a49d5b07f56c540a02af38cf8
fbshipit-source-id: d8a62f115a3f8a8a49d5b07f56c540a02af38cf8
2016-04-06 09:21:53 -07:00
Jason Axelson 9e18b21904 Minor improvements to Android docs
Summary:This is meant to help people who are just quickly scanning through the docs.

Please let me know of other ways this could be formatted to be more readable.
Closes https://github.com/facebook/react-native/pull/6102

Differential Revision: D2965869

fb-gh-sync-id: 00b9a29444709d409d34a1c016b52a03bf18d116
shipit-source-id: 00b9a29444709d409d34a1c016b52a03bf18d116
2016-02-23 09:01:31 -08:00
Konstantin Raev 6f1417c849 CI now builds docs website and deploys it to /%version% path
Summary:
Copy of #5760 reverted merge.

We need to preserve history of docs changes on the webserver.
The goal is to allow users to browse outdated versions of docs.
To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut.

I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it.

How it works:

1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder.
Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL.
All relative URLs will work within that website

2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder.
Github will serve this website from https://facebook.github.io/react-native/releases/v
Closes https://github.com/facebook/react-native/pull/5873

Reviewed By: svcscm

Differential Revision: D2926901

Pulled By: androidtrunkagent

fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1
shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 06:17:42 -08:00
张亦驰 dde5e02c01 fix the syntax error in doc tutorial
Summary:
maybe it is a bug when migrating from es5 to es6
Closes https://github.com/facebook/react-native/pull/5526

Reviewed By: svcscm

Differential Revision: D2860047

Pulled By: androidtrunkagent

fb-gh-sync-id: d8be261eea08ec659999fe8c714f33aca6fe3a60
2016-01-25 01:31:34 -08:00
Moz Morris f7cb745195 Update Tutorial.md with missing Component import
Summary: Closes https://github.com/facebook/react-native/pull/5484

Reviewed By: svcscm

Differential Revision: D2854745

Pulled By: androidtrunkagent

fb-gh-sync-id: b89a8dbef33cc0d89d5e94fa7c5f35219d7c8147
2016-01-22 06:54:33 -08:00
sunnylqm 7d457b09b4 Turn to ES6
Summary: Closes https://github.com/facebook/react-native/pull/5460

Reviewed By: svcscm

Differential Revision: D2850417

Pulled By: androidtrunkagent

fb-gh-sync-id: 8ba8bf935de53676cb4930712fabfe832208213f
2016-01-21 10:41:43 -08:00
Justas Brazauskas 264ece1f72 Fix typos in ./docs 2015-12-15 18:13:25 +02:00
Lev Taydakov ecc79dc6f5 Fix misspelling 2015-09-20 13:48:27 -07:00
Sahat Yalkabov 365cdde1ef Update iOS .xcodeproj path 2015-09-16 18:26:28 -07:00
Martin Konicek 42eb5464fd Release React Native for Android
This is an early release and there are several things that are known
not to work if you're porting your iOS app to Android.

See the Known Issues guide on the website.

We will work with the community to reach platform parity with iOS.
2015-09-14 18:13:39 +01:00
James Ide a97a866570 [Docs] Update installation docs to reference io.js instead of Node
It's pretty straightforward -- io.js is available through Homebrew so all you run is `brew install iojs` and then you can still run `node` from the command line. Also mentioned nvm since it's really good for switching between Node/io.js versions.
2015-07-02 11:42:25 -07:00
Brent Vatne c700f71cb5 [Docs] Add link to Homebrew in tutorial, suggestion for node install 2015-06-01 12:42:49 -07:00
Quico Moya c88b1d2c88 Fix grammatical error 2015-05-06 12:29:25 +02:00
Seyi Adebajo 03b73cc28c Fixed typo in tutorial 2015-03-30 00:46:06 -04:00
Tadeu Zagallo 9b0c2a4d30 Fix typo and add comments to the example app 2015-03-27 20:44:20 +00:00
Tadeu Zagallo b00d4b394f Update tutorial - use sample data 2015-03-27 20:33:24 +00:00
Dylan Kirby e23797bfc8 Fix 'respondible' typo in Tutorial 2015-03-27 14:41:10 -04:00
lqd 875b1359aa Fix a couple typos
I feel this is what the author meant :)
2015-03-26 22:27:05 +01:00
rsudekum 47cd815909 remove extraneous word 2015-03-26 10:59:03 -07:00
Andrew Rasmussen 09ffce48a3 Reference blog post in Tutorial 2015-03-26 10:38:23 -07:00
Krzysztof Magiera bc0ecaddc9 Update styles for ListView in tutorial 2015-03-26 09:03:10 -07:00
Krzysztof Magiera 049e3534b5 Update padding and bg color for tutorial 2015-03-26 09:01:41 -07:00
Krzysztof Magiera 8b8d5fd19b Use AwesomeProject instead of SampleApp in the final tutorial code 2015-03-26 08:52:15 -07:00
Krzysztof Magiera e340e01504 Further improvements of Tutorial.md 2015-03-26 08:42:27 -07:00
Krzysztof Magiera 4e4b90e1e8 Some tweaks of Tutorial.md 2015-03-26 08:13:30 -07:00
Andrew Rasmussen 3555e4be9e Update Tutorial.md 2015-03-26 00:35:23 -07:00
Spencer Ahrens 14b1a78600 Update some language in Tutorial.md 2015-03-26 00:19:03 -07:00
Andrew Rasmussen 74e72f2cd7 Update Tutorial.md 2015-03-25 22:15:12 -07:00
Andrew Rasmussen 0b3cce1fd2 Tutorial - shorten URL 2015-03-25 21:49:58 -07:00
Andrew Rasmussen b344c938df Update Tutorial.md 2015-03-25 21:08:46 -07:00
Christopher Chedeau 119a050ed8 Make images work 2015-03-25 20:30:41 -07:00
Andrew Rasmussen 41453a55d0 Finish tutorial draft 2015-03-25 19:57:37 -07:00
Andrew Rasmussen bd64b14fbe Update Tutorial.md 2015-03-25 17:53:08 -07:00
Christopher Chedeau 3b5c2617c5 Move around the docs a bit 2015-03-25 11:52:29 -07:00
Christopher Chedeau 3aee972116 Update Tutorial.md 2015-03-25 09:10:22 -07:00
Andrew Rasmussen eceed064f7 Add Tutorial.md 2015-03-25 02:08:09 -07:00