Skip to content
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

Pull all docs updates from 15-stable into 15.6-dev #9889

Merged
merged 35 commits into from
Jun 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
bef6848
Fix the proptypes deprecation warning url on the "Don't Call PropType…
gabriellett Apr 13, 2017
6e9e6e7
Docs: Clarification of setState() behavior (#9329)
ericelliott Apr 13, 2017
0478b6d
Update proptypes doc (#9391)
jackmarchant Apr 13, 2017
8af2f5c
Add tabs to installation page (#9275, #9277) (#9401)
markspolakovs Apr 13, 2017
0726180
Refractor docs to indicate that state set to props in constructor wil…
bytetwin Apr 12, 2017
97595a3
Switch Installation to a tab when hash is present (#9422)
gaearon Apr 13, 2017
f6d37c9
Updated the Good First Bug section in readme (#9429)
abhaynikam Apr 14, 2017
a46332d
[Documentation] Impreove the react-component section of doc (#9349)
NE-SmallTown Apr 18, 2017
c4b08b7
Unique headings for linking purposes (#9259)
wktfraser Apr 18, 2017
6aa3326
Update jsx-in-depth.md (#9178)
jayenashar Apr 18, 2017
86ce647
Sort out conferences by date (#9172)
designorant Apr 18, 2017
2b20688
Lift state up - Updating the documentation to mention that onClick is…
bytetwin Apr 18, 2017
a159a32
Fixed grammar (#9432)
abhisheksoni27 Apr 18, 2017
00757fa
[Tutorial] ES6, installation, and button closing tag (#9441)
brigand Apr 18, 2017
4d11d46
Minor tweaks to tutorial
gaearon Apr 18, 2017
d921593
Fix duplicate sentence
gaearon Apr 18, 2017
7b12cc3
Minor tutorial nits
gaearon Apr 18, 2017
8cf1193
Add missing tutorial sidebar links
gaearon Apr 18, 2017
2254660
Tweak tutorial structure
gaearon Apr 18, 2017
e100fee
FIX: Move CRA build info under it's tab page (#9452)
Apr 18, 2017
05920ca
Reorganize the "following along" instructions (#9453)
EnoahNetzach Apr 19, 2017
0f866ba
[Docs] Add accessibility to tabs in installation documentation (#9431)
AlmeroSteyn Apr 19, 2017
c388391
[Docs: Installation] Fix tabs responsive layout - Resubmit (#9458)
AlmeroSteyn Apr 20, 2017
6e6af0a
Add more details in jsx-in-depth.md (#9006)
davidhu2000 Apr 21, 2017
8cfc511
Add link to 'Typechecking with PropTypes' under 'Advanced Guides' (#9…
flarnie Apr 22, 2017
775f377
Updates how-to-contribute.md to use JSFiddle referenced in submit Git…
jenjwong Apr 23, 2017
a16288e
Describe fixtures dir in the codebase overview (#9516)
maciej-ka Apr 25, 2017
79c01c4
adds indirect refs to docs (#9528)
brigand Apr 26, 2017
8770ef8
Add reference to the Hyperscript libraries (#9517)
dmitriz Apr 26, 2017
41bad43
[Docs] Fix confusing description for the <script>...</script> usage (…
chocolateboy Apr 26, 2017
50b7c55
[site] Load libraries from unpkg (#9499)
Daniel15 Apr 26, 2017
824cb31
fixed error formatting in live editor (#9497)
tsriram Apr 26, 2017
ebcf1c3
React.createElement syntax (#9459)
Radi123 Apr 26, 2017
489d635
Add guide on integrating with non-react code (#9316)
wacii Apr 26, 2017
fefcb64
Don't build gh-pages branch on CircleCI (#9442)
zpao Apr 22, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions circle.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
general:
branches:
ignore:
- gh-pages

machine:
timezone: America/Los_Angeles
node:
Expand Down
4 changes: 4 additions & 0 deletions docs/_data/nav_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
items:
- id: jsx-in-depth
title: JSX In Depth
- id: typechecking-with-proptypes
title: Typechecking With PropTypes
- id: refs-and-the-dom
title: Refs and the DOM
- id: uncontrolled-components
Expand All @@ -48,6 +50,8 @@
title: Web Components
- id: higher-order-components
title: Higher-Order Components
- id: integrating-with-other-libraries
title: Integrating with Other Libraries
- title: Reference
items:
- id: react-api
Expand Down
19 changes: 18 additions & 1 deletion docs/_data/nav_tutorial.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,29 @@
- title: Tutorial
items:
- id: tutorial
title: Overview
title: Before We Start
subitems:
- id: what-were-building
title: What We're Building
href: /react/tutorial/tutorial.html#what-were-building
forceInternal: true
- id: prerequisites
title: Prerequisites
href: /react/tutorial/tutorial.html#prerequisites
forceInternal: true
- id: how-to-follow-along
title: How to Follow Along
href: /react/tutorial/tutorial.html#how-to-follow-along
forceInternal: true
- id: help-im-stuck
title: Help, I'm Stuck!
href: /react/tutorial/tutorial.html#help-im-stuck
forceInternal: true
- id: overview
title: Overview
href: /react/tutorial/tutorial.html#overview
forceInternal: true
subitems:
- id: what-is-react
title: What is React?
href: /react/tutorial/tutorial.html#what-is-react
Expand Down
2 changes: 1 addition & 1 deletion docs/_js/live_editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ var ReactPlayground = React.createClass({
} catch (err) {
this.setTimeout(function() {
ReactDOM.render(
<div className="playgroundError">{err.toString()}</div>,
<pre style={{overflowX: 'auto'}} className="playgroundError">{err.toString()}</pre>,
mountNode
);
}, 500);
Expand Down
22 changes: 11 additions & 11 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@
<script>try{Typekit.load();}catch(e){}</script>

<!--[if lte IE 8]>
<script src="/react/js/html5shiv.min.js"></script>
<script src="/react/js/es5-shim.min.js"></script>
<script src="/react/js/es5-sham.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/html5shiv.min.js"></script>
<script src="https://unpkg.com/[email protected]/es5-shim.min.js"></script>
<script src="https://unpkg.com/[email protected]/es5-sham.min.js"></script>
<![endif]-->
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
<script src="/react/js/codemirror.js"></script>
<script src="/react/js/javascript.js"></script>
<script src="/react/js/xml.js"></script>
<script src="/react/js/jsx.js"></script>
<script src="/react/js/react.js"></script>
<script src="/react/js/react-dom.js"></script>
<script src="/react/js/babel.min.js"></script>
<script src="https://unpkg.com/docsearch.js@1.5.0/dist/cdn/docsearch.min.js"></script>
<script src="https://unpkg.com/codemirror@5.15.2"></script>
<script src="https://unpkg.com/[email protected]/mode/javascript/javascript.js"></script>
<script src="https://unpkg.com/[email protected]/mode/xml/xml.js"></script>
<script src="https://unpkg.com/[email protected]/mode/jsx/jsx.js"></script>
<script src="https://unpkg.com/react/dist/react.min.js"></script>
<script src="https://unpkg.com/react-dom/dist/react-dom.min.js"></script>
<script src="https://unpkg.com/[email protected]/babel.min.js"></script>
<script src="/react/js/live_editor.js"></script>
</head>
<body>
Expand Down
5 changes: 5 additions & 0 deletions docs/circle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
general:
branches:
ignore:
- gh-pages
20 changes: 10 additions & 10 deletions docs/community/conferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ March 28th at the [QEII Centre, London](http://qeiicentre.london/)

[Website](http://react.london/)

### ReactEurope 2017
May 18th & 19th in Paris, France

[Website](http://www.react-europe.org/) - [Schedule](http://www.react-europe.org/#schedule)

### React Amsterdam 2017
April 21st in Amsterdam, The Netherlands

[Website](https://react.amsterdam) - [Twitter](https://twitter.com/reactamsterdam)

### ReactEurope 2017
May 18th & 19th in Paris, France

[Website](http://www.react-europe.org/) - [Schedule](http://www.react-europe.org/#schedule)

### Chain React 2017
July 10-11 in Portland, Oregon USA

Expand All @@ -34,6 +34,11 @@ August 24-25 in Salt Lake City, Utah USA

[Website](http://www.reactrally.com) - [Twitter](https://twitter.com/reactrally)

### React Native EU 2017
September 6-7 in Wroclaw, Poland

[Website](http://react-native.eu/)

### ReactJS Day 2017
October 6th in Verona, Italy

Expand All @@ -44,11 +49,6 @@ October 13 in Stockholm, Sweden

[Website](https://statejs.com/)

### React Native EU 2017
September 6-7 in Wroclaw, Poland

[Website](http://react-native.eu/)


## Past Conferences

Expand Down
7 changes: 3 additions & 4 deletions docs/contributing/codebase-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var setInnerHTML = require('setInnerHTML');

Haste was originally developed for giant apps like Facebook. It's easy to move files to different folders and import them without worrying about relative paths. The fuzzy file search in any editor always takes you to the correct place thanks to globally unique names.

React itself was extracted from the Facebook codebase and uses Haste for historical reasons. In the future, we will probably [migrate React to use CommonJS or ES Modules](https:/facebook/react/issues/6336) to be more aligned with the community. However, this requires changes in Facebook internal infrastructure so it is unlikely to happen very soon.
React itself was extracted from Facebook's codebase and uses Haste for historical reasons. In the future, we will probably [migrate React to use CommonJS or ES Modules](https:/facebook/react/issues/6336) to be more aligned with the community. However, this requires changes in Facebook's internal infrastructure so it is unlikely to happen very soon.

**Haste will make more sense to you if you remember a few rules:**

Expand Down Expand Up @@ -66,6 +66,7 @@ After cloning the [React repository](https:/facebook/react), you wil

* [`src`](https:/facebook/react/tree/master/src) is the source code of React. **If your change is related to the code, `src` is where you'll spend most of your time.**
* [`docs`](https:/facebook/react/tree/master/docs) is the React documentation website. When you change APIs, make sure to update the relevant Markdown files.
* [`fixtures`](https:/facebook/react/tree/master/fixtures) contains a few small React test applications for contributors.
* [`packages`](https:/facebook/react/tree/master/packages) contains metadata (such as `package.json`) for all packages in the React repository. Nevertheless, their source code is still located inside [`src`](https:/facebook/react/tree/master/src).
* `build` is the build output of React. It is not in the repository but it will appear in your React clone after you [build it](/react/contributing/how-to-contribute.html#development-workflow) for the first time.

Expand Down Expand Up @@ -223,7 +224,7 @@ module.exports = ReactDOMComponent;

The `Mixin` in this code has no relation to React `mixins` feature. It is just a way of grouping a few methods under an object. Those methods may later get attached to some other class. We use this pattern in a few places although we try to avoid it in the new code.

Equivalent code in ES6 would look like this:
The equivalent code in ES6 would look like this:

```js
class ReactDOMComponent {
Expand Down Expand Up @@ -301,10 +302,8 @@ While the code is separated in the source tree, the exact package boundaries are
The "core" of React includes all the [top-level `React` APIs](/react/docs/top-level-api.html#react), for example:

* `React.createElement()`
* `React.createClass()`
* `React.Component`
* `React.Children`
* `React.PropTypes`

**React core only includes the APIs necessary to define components.** It does not include the [reconciliation](/react/docs/reconciliation.html) algorithm or any platform-specific code. It is used both by React DOM and React Native components.

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ We are using [GitHub Issues](https:/facebook/react/issues) for our p

#### Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case. This [JSFiddle template](https://jsfiddle.net/reactjs/69z2wepo/) is a great starting point.
The best way to get your bug fixed is to provide a reduced test case. This [JSFiddle template](https://jsfiddle.net/84v837e9/) is a great starting point.

#### Security Bugs

Expand All @@ -64,7 +64,7 @@ Working on your first Pull Request? You can learn how from this free video serie

**[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)**

To help you get your feet wet and get you familiar with our contribution process, we have a list of **[good first bugs](https:/facebook/react/labels/good%20first%20bug)** that contain bugs which are fairly easy to fix. This is a great place to get started.
To help you get your feet wet and get you familiar with our contribution process, we have a list of **[beginner friendly issues](https:/facebook/react/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+beginner%22)** that contain bugs which are fairly easy to fix. This is a great place to get started.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

Expand Down Expand Up @@ -101,7 +101,7 @@ In order to accept your pull request, we need you to submit a CLA. You only need

### Development Workflow

After cloning React, run `npm install` to fetch its dependencies.
After cloning React, run `npm install` to fetch its dependencies.
Then, you can run several commands:

* `npm run lint` checks the code style.
Expand Down
Loading