41 Commits

Author SHA1 Message Date
Sophie Alpert 8c3cececb7 15.x: BSD+Patents -> MIT 2017-09-25 17:02:44 -07:00
Kiho · Cham 141179a24e doc: fix the order of lint and prettier (#10095)
(cherry picked from commit 03db57aa71)
2017-07-11 14:06:09 +01:00
Fernando Montoya 414deb16ce Update webpack according to brand guidelines (#9595)
* Update webpack according to brand guidelines

* Change all ocurrences to webpack
2017-06-09 23:19:09 +01:00
Maciej Kasprzyk fd3830453f Describe fixtures dir in the codebase overview (#9516)
* Describe fixtures dir in overview

* Fix folder name

(cherry picked from commit d12c41c7a6)
2017-04-26 17:28:39 +01:00
Jen Wong ac1a4665e2 Updates how-to-contribute.md to use JSFiddle referenced in submit Git issue template (#9503)
(cherry picked from commit c8a64e2637)
2017-04-26 17:28:39 +01:00
Abhishek Soni 6afb4826f2 Fixed grammar (#9432)
* Update codebase-overview.md

* Some more fixes

(cherry picked from commit d724115144)
2017-04-18 16:51:05 +01:00
Abhay Nikam 20a9c31f3d Updated the Good First Bug section in readme (#9429)
* Updated the Good First Bug section in readme

* Inconsistent use of quotes. Prefered single quotes instead of double quotes

* Updated Good first bug link in how_to_contribute doc.

* Undo JSX attribute quote change

* don't capitalize "beginner friendly issue"

(cherry picked from commit 36c935ca8f)
2017-04-18 16:51:03 +01:00
Jack a63ecad10e Update proptypes doc (#9391)
* Update proptypes doc

* Removed note
2017-04-13 20:55:55 +01:00
Maciej Kasprzyk 9e9e0c700c Delete examples dir from codebase overview (#9397)
Removes doc about folder that no longer exists.
2017-04-11 22:05:47 +01:00
Luke Belliveau 8f951556e1 Amended implementation-notes.md with link to Dan Abramov's post describing difference between React components, elements, and instances (#9388)
* Amended implementation-notes.md to include a link to a blog post by Dan Abramov, explaining the difference between components, elements, and instances. An understanding of this distinction is crucial in tracing through Implementation pseudocode, and reading Dan's blog first may ease newcomers into understanding the implementation.

* adjusted wording to maintain stylistic consistency with rest of content, per @aweary's request
2017-04-11 22:05:23 +01:00
Flarnie Marchan 0420e96a41 All doc updates forv15.5 (#9359)
* `react-addons-test-utils` -> `react-dom/test-utils`

Updating all references and docs on the `React.addons.TestUtils` and the
shallow renderer to refer to the correct targets.

Instead of:
```
const React = require('react');

// ...
React.addons.Testutils
// or

const ReactTestUtils = require('react-addons-test-utils');
```
we now show:
```
const ReactTestUtils = require('react-dom/test-utils');
```

And for shallow renderer, instead of:
```
const shallowRenderer = TestUtils.createRenderer();
```

we now show:
```
const shallowRenderer = require('react-test-renderer/shallow');
```

* Update the 'prev' and 'next' attributes of 'add-ons' docs

These flags are used to set arrow links to easily navigate through the
documents. They were wrong or missing in some of the 'add-ons' pages and
this bothered me when manually testing the updates from the previous
commit.

* Update syntax for instantiating shallow renderer

Missed this when updating the docs for the changes to shallow-renderer
in React 15.5.

* Fix pointers in addons docs

Thanks @bvaughn for catching this

* Make example of shallow renderer more consistent

We should show using the same variable names between code samples.

* Make names in example even more consistent

We should use the same variable name for the same thing across examples.
`renderer` -> `shallowRenderer`.

* Update docs to deprecate React<CSS>TransitionGroup

 - removes link to the docs about `ReactCSSTransitionGroup` and
   `ReactTransitionGroup` from the main navigation
 - updates 'prev' and 'next' pointers to skip this page
 - adds deprecation warning to the top of the page
 - remove references to these modules from the packages README
 - updates 'add-ons' main page to list this as a deprecated add-on

* Update `React.createClass` to `createReactClass` in the docs

The `React.createClass` method is being deprecated in favor of
`createReactClass`.

* Remove 'React.createClass' from top level API docs

It no longer makes sense to have a section for the 'createClass' method
in this page, since it won't be available as a top level method on
'React'.

I initially was going to pull the section about 'createClass' into a
separate page to add under 'addons' but it was short and duplicative of
the 'react-without-es6' docs. So I just linked to those.

* Remove *most* `React.PropTypes` from the docs

I am doing the docs for `context` in a separate commit because that case
was a bit less clear-cut.

We will no longer support `React.PropTypes` as a built-in feature of
React, and instead should direct folks to use the `PropTypes` project
that stands alone.

Rather than retaining the `React.PropTypes` examples and just revamping
them to show the use of the stand-alone `PropTypes` library with React,
it makes more sense to direct people to that project and reduce the
perceived API area and complexity of React core. The proper place to
document `PropTypes` is in the README or docs of that project, not in
React docs.

* Update `context` docs to not use `React.PropTypes`

We use `React.PropTypes` to define the `contextType` for the `context`
feature of React. It's unclear how this will work once `React.PropTypes`
is replaced by the external `PropTypes` library. Some options;

a) Deprecate `context`, either in v16 or shortly after. Seems reasonable
based on the intense warnings against using context that we have in the
docs -
https://facebook.github.io/react/docs/context.html#why-not-to-use-context
**Except** that probably some widely used libraries depend on it, like
`React-Router`.

b) Expect users will use external `PropTypes` library when defining
`contextTypes` and just don't do our `checkReactTypeSpec` against them
any more in v16.

c) Stop masking context and pass the whole context
unmasked everywhere. Worst option, do not recommend.

I went with `b` and assume that, for now, we will get users to use the
external `PropTypes` when defining context. I will update this PR if we
want a different approach.

* Remove 'addons' items from left nav, and deprecate 'addons' doc page

The plan:
[X] Remove links to 'addons' items from main navigation
[X] Add deprecation notices where appropriate, and update syntax to show
using the separate modules.
[ ] Update other references to 'React.addons' in docs. Coming in next
commit.
--- blocked but coming in future PRs
[ ] Link to a blog post describing the new locations of add-ons in the
deprecation notice on the '/docs/addons.html' page. Blocked until we
actually publish that blog post.
[ ] Move the docs for each add-on to the actual github repo where it now
lives.
[ ] Redirect the old add-ons doc permalinks to the docs in the separate
github repos for those modules.
[ ] Remove the old add-ons doc markdown files from React core docs.

* Remove references to `React.addons` from docs

Just misc. places where we referenced the 'addons' feature. All gone!
2017-04-07 14:12:10 -07:00
najisawas 7a11c572e6 Fixed typo on implementation notes page (#9258)
Added paren to "mountComponent()" for consistency
2017-04-07 14:06:58 -07:00
Giorgio Polvara 9b4d42ca64 Fix typo (#7953) 2017-04-07 14:06:36 -07:00
Justin b9f9b3cce6 Fix grammar typo in Design Principles docs (#9324)
features → feature
> There is nothing "bad" about using state or lifecycle hooks in components. Like any powerful feature**s**, they should be used in moderation, but we have no intention to remove them.

I can’t explain the exact grammatical principle this violates, but it sounds wrong to my native English ears that “feature” is plural here. Another way to check if the grammar sounds right is to change the order of the clauses: ”They should be used in moderation, like any powerful feature“ sounds right, whereas “They should be used in moderation, like any powerful features” does not.
2017-04-07 14:03:46 -07:00
Dan Abramov c549c8b66e Update build paths in docs (#9340) 2017-04-07 14:03:09 -07:00
Andrew Clark c5395d23e5 Merge pull request #9187 from acdlite/prettierci
Failing to run prettier should block CI
(cherry picked from commit 9549ebfae5)
2017-03-24 09:48:44 -05:00
Prayag Verma 34b6e1f80c Fix a typo in design principles doc (#8985)
unambigious → unambiguous
(cherry picked from commit c60f852cdb)
2017-02-13 23:30:52 +00:00
Ragnar Þór Valgeirsson d8700e8d4e Match eslint's line length settings (#8845)
(cherry picked from commit 09b3ec5d3c)
2017-01-23 17:19:23 +00:00
Jack Cross 5446c47c1d Add Flow reminder to PR template (#8805)
* Added flow to PR template

* Added record-tests step to PR template and contribution docs

* Updated order of PR checks

(cherry picked from commit bfd5b1878e)
2017-01-18 12:44:25 -06:00
Richie Thomas 9b0301345b Remove one extraneous backtick from line 116 of 'codebase-overview.md' (#8724). (#8726)
(cherry picked from commit b2cc91e83a)
2017-01-09 14:58:40 -06:00
Joel Sequeira a824fbfd08 Fix typo in Proposing a Change section in how-to-contribute.md (#8498)
* Fix typo in Proposing a Change section in how-to-contribute.md

Not sure if it was actually intended or was a typo but changed 'If you intend to change to the public API' --> 'If you intend to make a change to the public API'

* Simplify
2017-01-04 17:30:16 +00:00
Brian Vaughn 4bfa07a929 Merge pull request #8671 from bonham000/update-docs
update to codebase-overview.md
2017-01-04 16:13:22 +00:00
Shuhei Kagawa 04f1fe7fbf Correct a method param in Implementation Notes (#8252)
(cherry picked from commit fa4710fe51)
2016-11-16 15:22:39 +00:00
Guilherme Oenning e5e387da9e fix broken docs links (#8163)
* fix broken links to outdated code

* another broken links to outdated code

* update hash commit & folder structure to current

(cherry picked from commit b847226ec4)
2016-11-16 15:22:38 +00:00
Lee Sanghyeon d128b45c6f Update codebase-overview.md (#8142)
* Update codebase-overview.md

Fix the broken source code URL in 'Event System' section.

* Update codebase-overview.md

Re-fix link name
2016-11-08 19:20:59 +00:00
Piper Chester 89defaa712 Fix grammatical error 2016-10-22 22:05:15 +01:00
Phil Quinn 24dd09fea7 correct order of params in documentation (#7989) 2016-10-22 22:04:36 +01:00
CT Wu 1d108d8f6a Fix a typo in the doc (#7969) 2016-10-22 22:04:13 +01:00
Dan Abramov 60ec3c6b37 Fix redirects 2016-10-21 22:01:06 +01:00
Kevin Lacker 1cf81c1aa9 New Documentation 2016-10-21 21:00:10 +01:00
Alex Babkov cd65b60960 Typo fixes in codebase-overview.md (#7938) 2016-10-11 12:09:33 +01:00
Aesop Wolf b52288cbcf Update codebase-overview.md (#7934)
Fix typo
2016-10-11 12:09:20 +01:00
Dan Abramov 2b5c43029e Add Implementation Notes and amend Codebase Overview (#7830)
* Add more to Codebase Overview

* WIP

* Start a reconciler overview

* Add a few more sections

* todo

* WIP

* Finish it

* Whitespace

* Minor tweaks

* Minor tweaks
2016-10-10 17:30:18 +01:00
Steve Mao ffa70704ca simplify npm link script a little bit (#7862)
We don't need to remove the folders before linking the modules
2016-10-04 12:20:49 +01:00
Ivan Zotov ecd66274a7 Fix mistakes in the codebase overview (#7834)
(cherry picked from commit 16ac141f44)
2016-10-03 15:54:26 -07:00
Dan Abramov 58d66ad47f Add Codebase Overview (#7828)
* Add Codebase Overview

* Update codebase-overview.md

* Update codebase-overview.md
2016-09-29 11:34:35 +01:00
Dan Abramov ae5ebe3d92 Move How to Contribute to documentation and update it (#7817)
* Move How to Contribute to documentation and update it

* Consistent formatting
2016-09-27 23:22:32 +01:00
Paul O’Shannessy dfebed11c2 Merge pull request #7308 from zpao/jekyll3
Upgrade to Jekyll 3
(cherry picked from commit 5e3959e071)
2016-07-19 16:36:23 -07:00
Dan Abramov 108f25350d Clarify the section about dogfooding (#7292) 2016-07-16 15:03:00 +01:00
Dan Abramov f40b5b5c47 Minor tweaks to Design Principles (#7283) 2016-07-14 21:30:13 +01:00
Dan Abramov b38bbde2fe Add Design Principles to the docs (#7282) 2016-07-14 20:39:41 +01:00