New guides wanted

[bvaughn]

Note this issue has some overlap with FAQ section issue #29.

We revamped the docs, but there are a few guides that are missing and that I think are essential.

Available

• @mateoholman Community section with good resources (e.g. Add Learning Resources section to the Community Resources on the website facebook/react#7117)
• @mrscobbler Glossary (similar to "Virtual DOM Terminology" that is now gone, but more friendly. Check http://redux.js.org/docs/Glossary.html for inspiration.)
• @chiangs Troubleshooting (there are ~5 common issues we should explain right away, like wrong element casing, not loaded DOM container, missing React in scope, etc. See http://redux.js.org/docs/Troubleshooting.html for inspiration)
• @madhug Manipulating Children (Using cloneElement and Children React.cloneElement docs are a bit light facebook/react#6942)
• "Portals" (useful for modals)
• @mateoholman Animation with React Motion
• @jamesknelson Routing (no need to use React Router here, just show how to use setState with HTML5 history API and point to RR as a component-based API for it once v4 is out)
• @ishankbahl Snapshot testing (Write documentation for react-test-renderer facebook/react#7431)
• @mateoholman Publishing a Component (Docs request: build a React component library facebook/react#7882)

In progress

• @alexkrolick, @ishankbahl: AJAX (just show how to use fetch() in lifecycles, mention cancellation issues)

If somebody wants to work on this please comment here and let's figure out a plan. Help wanted!

Carry over from facebook/react/issues/8060

[markerikson]

The ReactPerf item may sorta be OBE ("overtaken by events"), since it's not included in v16.

[bvaughn]

Not sure what that acronym means but I assume you're suggesting we should remove it? 😄 I don't object.

[JasonEtco]

Not sure if you're already planning it, but I would add Didn't bind class methods to common troubleshooting issues 👍

[markerikson]

@bvaughn : yeah, that's what I was suggesting :)

@JasonEtco : the "troubleshooting" suggestion overlaps heavily with the proposal for an FAQ page.

[AlmeroSteyn]

@bvaughn Accessibility has been added and can be checked off :-)

[mrscobbler]

I'll take the glossary that I created in the old repo and migrate it to the new docs repo

[alexkrolick]

As @markerikson mentioned there is some overlap with the FAQ discussion (#29). PR #43 covers AJAX and some of the VDOM concepts although a full-fledged glossary would probably replace that section.

[bvaughn]

Thanks @AlmeroSteyn. I've removed that entry.

Yeah, there's some overlap. I spent a few hours merging/moving issues and PRs yesterday but some of the larger/vaguer ones like this are a bit hard to do without a bit of overlap. I'll add a note in the description about the relationship.

[ishankbahl]

Hey @bvaughn , I would like to work on "AJAX (just show how to use fetch() in lifecycles, mention cancellation issues)". Though now we don't have to talk about cancellation issues as fetch now supports abort https://developers.google.com/web/updates/2017/09/abortable-fetch
Can I take this one?

[bvaughn]

It's all yours, @ishankbahl

[alexkrolick]

@ishankbahl @bvaughn AJAX is already in the FAQ PR #43, as I pointed out.

If that is too big of a PR to review I can break it up, but let's not duplicate effort.

[bvaughn]

Sorry for missing that note, @alexkrolick. Thanks for pointing it out. Yeah, maybe hold off on doing anything with the AJAX section until after #43 has been reviewed @ishankbahl.

[mrscobbler]

I just created a pull request for the glossary content: #153

[damaera]

while in vue docs there's something like this.

I think routing should have their own menu, because almost all SPA have router.
state management too.

[mateoholman]

I'll take a stab at creating a guide for publishing a component if no one is currently working on it?

[bvaughn]

Ok @mateoholman

[ishankbahl]

@bvaughn Can I take snapshot testing?

[bvaughn]

Sure @ishankbahl

[ishankbahl]

@bvaughn What outline do you suggest for this guide?

[bvaughn]

No clue 😄 Haven't thought about it any. Just migrated this issue from the old GitHub repo.

[mateoholman]

Created a new PR for the "Publishing a Component" guide - #211.

[mateoholman]

I'll try to tackle the community section per the recommendations in facebook/react#7117 next if no one is currently working on it?

[bvaughn]

It's yours, @mateoholman

[mateoholman]

After doing some prep/research, I see two approaches to the community section. Adding a new Resources section to the docs page similar to the React Native Docs or updating the React Wiki. Both have been suggested in previous issues - any preference @bvaughn ?

[bvaughn]

👋 Hi @mateoholman. Sorry for the slow response time but I've been traveling.

I'm personally more a fan of the community page/section because it's more open for community contributions.

[mateoholman]

👋 Hi @bvaughn . No worries, I had been scrubbing some of the outdated / broken links from the previous section. I should have a PR ready for review in a few days. 🍻

[mateoholman]

@bvaughn Created a PR for the updated community section PR #252 . Mind if I take the "Animation with React Motion" guide next?

[bvaughn]

Sure @mateoholman. It's yours.

[chiangs]

@bvaughn I'd like to take the Troubleshooting Guide:

Besides the following you listed (like wrong element casing, not loaded DOM container, missing React in scope) any other items you suggest being covered?

[bvaughn]

Okay @chiangs, please feel free to work on that! :)

[alDuncanson]

It looks like portals have been taken care of right?

https://reactjs.org/docs/portals.html

[spiritanand]

Is this issue open? Can you assign it to me if it is?

[KenFoss]

@bvaughn Is anyone taking animation with react motion? I would like to give it a go.