react.dev icon indicating copy to clipboard operation
react.dev copied to clipboard

New guides wanted

Open bvaughn opened this issue 7 years ago • 33 comments

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. https://github.com/facebook/react/pull/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 https://github.com/facebook/react/issues/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 (https://github.com/facebook/react/issues/7431)
  • [ ] @mateoholman Publishing a Component (https://github.com/facebook/react/issues/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

bvaughn avatar Oct 08 '17 20:10 bvaughn

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

markerikson avatar Oct 08 '17 20:10 markerikson

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

bvaughn avatar Oct 08 '17 20:10 bvaughn

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

JasonEtco avatar Oct 08 '17 20:10 JasonEtco

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

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

markerikson avatar Oct 08 '17 22:10 markerikson

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

AlmeroSteyn avatar Oct 09 '17 05:10 AlmeroSteyn

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

mrscobbler avatar Oct 09 '17 06:10 mrscobbler

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.

alexkrolick avatar Oct 09 '17 07:10 alexkrolick

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.

bvaughn avatar Oct 09 '17 15:10 bvaughn

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?

ishankbahl avatar Oct 10 '17 10:10 ishankbahl

It's all yours, @ishankbahl

bvaughn avatar Oct 10 '17 16:10 bvaughn

@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.

alexkrolick avatar Oct 10 '17 19:10 alexkrolick

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.

bvaughn avatar Oct 10 '17 21:10 bvaughn

I just created a pull request for the glossary content: https://github.com/reactjs/reactjs.org/pull/153

mrscobbler avatar Oct 12 '17 23:10 mrscobbler

while in vue docs there's something like this. image

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

damaera avatar Oct 16 '17 08:10 damaera

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

mateoholman avatar Oct 20 '17 19:10 mateoholman

Ok @mateoholman

bvaughn avatar Oct 20 '17 19:10 bvaughn

@bvaughn Can I take snapshot testing?

ishankbahl avatar Oct 22 '17 08:10 ishankbahl

Sure @ishankbahl

bvaughn avatar Oct 22 '17 16:10 bvaughn

@bvaughn What outline do you suggest for this guide?

ishankbahl avatar Oct 22 '17 21:10 ishankbahl

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

bvaughn avatar Oct 22 '17 22:10 bvaughn

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

mateoholman avatar Oct 25 '17 21:10 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?

mateoholman avatar Oct 25 '17 21:10 mateoholman

It's yours, @mateoholman

bvaughn avatar Oct 25 '17 21:10 bvaughn

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 ?

mateoholman avatar Oct 27 '17 15:10 mateoholman

👋 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.

bvaughn avatar Oct 31 '17 18:10 bvaughn

:wave: 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. :beers:

mateoholman avatar Nov 01 '17 20:11 mateoholman

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

mateoholman avatar Nov 07 '17 03:11 mateoholman

Sure @mateoholman. It's yours.

bvaughn avatar Nov 07 '17 10:11 bvaughn

@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?

chiangs avatar Oct 02 '19 11:10 chiangs

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

bvaughn avatar Oct 02 '19 16:10 bvaughn