[WIP] GitHub Pages: Getting Started, Migrating, etc. #260

gadicc · 2016-04-26T10:51:48Z

Hi all, this PR is tracking all current work on the docs for gh-pages (that will replace http://gaearon.github.io/react-hot-loader/).

Additional PRs are welcome against the gh-pages-next branch, which will be squashed before the final merge. Please mention this issue (#260) in your PR so everyone involved in docs will be notified.

See also https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/.

(This is the continuation of #255)

See also #257 for the non-gh-pages docs that live in the repo.

gadicc · 2016-04-26T10:54:23Z

I (mistakenly) put a lot of stuff in the docs directory, that I'll move over to here shortly.

gadicc · 2016-04-26T13:10:11Z

@hedgerh I merged in the stuff that I mistakenly put in the non-gh-pages docs, and that @tsaiDavid helped with, to getstarted.md. It follows the 3-step outline that gaearon suggested. I removed references to the old version of the plugin. I left the main Webpack outline in and put your changes there, I'll leave this to you, because, I don't use or know how to use Webpack :) We can carry on working from here.

hedgerh · 2016-04-26T16:02:16Z

Sounds good. I'm going to spend some time on the docs now.

hedgerh · 2016-04-26T16:22:34Z

I'm filling out step 1/3 now.

tsaiDavid · 2016-04-26T16:22:56Z

@gadicc @hedgerh - any areas that either of you need a hand with? Happy to help - got a bit confused as to where the changes I had made went.

hedgerh · 2016-04-26T16:24:47Z

@tsaiDavid Has any of your work been lost, or is what is available here up to date?

tsaiDavid · 2016-04-26T16:32:06Z

@hedgerh - Pinged you on gitter - but I just spun up jekyll. Since the docs aren't going to be in plain markdown, the 'jsx' syntax highlighting is not going to work properly. But it looks like everything else is there!

gadicc · 2016-04-26T16:49:46Z

@tsaiDavid, oh yes, sorry, I meant to mention that I had to jsx -> js for the highlighting because of the change, but glad eveything else is there.

@tsaiDavid, @hedgerh, I also enabled GFM for the markdown engine and as you saw, in the latest version of the engine we can do GFM style code fences, so no more missioning with the long jekyll syntax for that. The CSS is a bit different though.

I might have to take a step back until next week, but I'll follow the progress and chip in where I can. jekyll drove me crazy today :D

…ated

gadicc · 2016-05-03T13:20:09Z

Hey @hedgerh, @tsaiDavid, can you give an update on anything you guys discussed and/or are working on?

Let's try finish this up in the next few days if possible, now that we're already in beta.

… branch

@tsaiDavid

…UIDE @tsaiDavid / @hedgerh, hope this doesn't affect anything you haven't commited yet, just trying to get things ready for an initial publish. I can't remember which of you did the webpack config with your comments, but yes, I agree, better to not be overbearing; so I removed comment and left things identifiable but minimal.

gadicc · 2016-05-06T13:21:30Z

@gaearon, what are your thought on the current state of the docs or in particular the getstarted guide? I setup a preview of the branch at http://rhl-docs.gadi.cc:4000/react-hot-loader/getstarted/ and of course you can comment on the lines here. Maybe better to get the guide online and do further work later? The two "XXX" sections could be cleaned up quite easily (when do you plan to merge the next branches?)

gaearon · 2016-05-06T15:13:22Z

Hi, thanks for your work! I’ll take a look when I get some time but likely not earlier than next weekend.

hedgerh · 2016-05-11T07:10:39Z

getstarted.md


-This tutorial assumes that you already have a working Webpack configuration and `WebpackDevServer` compiles and serves your code. If youʼd rather play with a ready-made example, try <a href="https://github.com/gaearon/react-hot-boilerplate" target="_blank">react-hot-boilerplate</a>.
+## Boilerplate Example


I think this heading is a little confusing, since the first sentence introduces the getting started content, but this paragraph is actually about the boilerplate. I think "Introduction" would be great, or something that essentially says "Want a quick start? Try the boilerplate." in a clearer voice.

Agree. If you're already working on this, feel free to just change it. Don't forget to pull in the changes from the other PR first though.

hedgerh · 2016-05-11T07:45:37Z

getstarted.md


-**XXX cleanup, details**
+If you only render on the client, this is the easier option and quicker to setup.  The key aspect of this configuration is that when creating a `new WebpackDevServer`, you need to specify `hot: true` as an option. For example, you can add an entirely new file called `server.js` and simply include the [server provided in the boilerplate](https://github.com/gaearon/react-hot-boilerplate/blob/master/server.js){:target="_blank"}.


For example, you can add an entirely new file called server.js and simply include the server provided in the boilerplate.

At first, I didn't realize you meant to just copy the boilerplate's server.js into my project. Maybe we could rewrite this paragraph to:

If you're only rendering on the client side, this is the easier option, and quicker to setup. You can simply copy the server.js from the boilerplate into your project. The key aspect of this configuration is that when creating a new WebpackDevServer, you need to specify hot: true as an option.

and then maybe just include the server.js code as a codeblock. What do you think?

Agree. I actually thought you wrote this :D All the Webpack stuff is either you, @tsaiDavid, left over from before, or just me summarizing what was already there. In general I might be a bit useless for the Webpack stuff, since I don't use or know Webpack. So consider all your views on the Webpack stuff as absolute :)

Grammar fixes.

hedgerh · 2016-05-11T07:59:01Z

@gaddic @tsaiDavid Been pretty busy, but took some time to review the Getting Started guide. It's looking great! I made some typo fixes in another PR and left some line comments. I think something weird happened and I commented on a specific commit for a few different comments :O

Another thing I noticed is that the links are kind of hard to distinguish from regular text. I completely missed the links to the boilerplate's webpack.config.js and any other links that used this styling. We should make them more noticeable. Agree?

gadicc · 2016-05-11T08:08:57Z

@hedgerh, great stuff! Yeah it's pretty hectic doing this amongst other work but I think we're doing a great job :) Yeah it did say one was on an outdated diff... if you left a github tab open, sometimes they don't update... when I do this I've gotten into the habit of ctrl-R before commenting.

Agree. Links should be real links, not formatted as code. As per other comment, if you're working on this now, feel free to fix (I switched the other links to markdown for consistency), otherwise we'll do it. Here are the two issues that either of us can check off when done :)

Move explanatory comments from "Putting it all together" to relevant sections (ref)
References to other files should be real links, not formatted as code (above)

hedgerh · 2016-05-11T08:11:35Z

@gadicc I'm working on this now. I can take care of both of these. :D

hedgerh · 2016-05-11T15:28:31Z

Did a lot of work on the Getting started guide. Still needs a couple of things worked out, plus the webpack-dev-middleware how to. Let me know what you think, especially if its too much 😵

calesce · 2017-02-27T14:11:31Z

This hasn't been worked on in 10 months, and I'm thinking that we probably won't need a separate website for docs. The surface API of RHL is pretty small, and markdown files in the repository are more suitable IMO. Also, we already cover most of the copy in this PR.

Let me know if anyone disagrees, otherwise we can close this.

hedgerh added 2 commits April 21, 2016 22:26

Get Started Guide

5a5ef32

Format change to headers.

e66b924

gadicc added the docs label Apr 26, 2016

gadicc added this to the v3.0 milestone Apr 26, 2016

gadicc mentioned this pull request Apr 26, 2016

[docs] [WIP] Getting Started Guide #255

Closed

gadicc mentioned this pull request Apr 26, 2016

[WIP] Repository Documentation (non-gh-pages) #257

Merged

gadicc added 2 commits April 26, 2016 15:01

Updates for later versions of Jekyll

f8a8820

merge with the 3-step getting started doc mistakenly in #257

48470a5

gaearon mentioned this pull request Apr 30, 2016

Please review my blog: "Enabling Webpack’s HMR In React — The Missing Manual" webpack/webpack#2418

Closed

gadicc added 2 commits May 3, 2016 15:13

Gemfile for gh-pages

9dc810d

remove "XXX pending" note now that <AppContainer component={}> deprec…

f91854c

…ated

gadicc added 3 commits May 5, 2016 10:18

add a note about rhl/webpack exports vs rhl/babel top-level vars

c0b3b6f

mention that boilerplate URL is pending merge of the PR, link to next…

67a4eaa

… branch

hedgerh reviewed May 11, 2016
View reviewed changes

Grammar fixes.

1fca353

hedgerh reviewed May 11, 2016
View reviewed changes

Merge pull request #293 from gaearon/gh-pages-next-revisions

b4a8650

Grammar fixes.

hedgerh added 3 commits May 11, 2016 11:24

Big copy revisions to steps. mostly copy changes.

67e38cb

Removed test h1

fc30ed7

Increased opacity of link underlines.

2be38d4

hedgerh mentioned this pull request Aug 10, 2016

Document React Hot Loader 3 #243

Closed

calesce mentioned this pull request Oct 29, 2016

Update "Get started" guide #407

Closed

Improved getting started guide

ad9d620

wkwiatek force-pushed the gh-pages-next branch from 4089a9b to ad9d620 Compare February 28, 2017 11:07

wkwiatek merged commit 1257542 into gh-pages Mar 2, 2017

wkwiatek deleted the gh-pages-next branch March 2, 2017 12:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] GitHub Pages: Getting Started, Migrating, etc. #260

[WIP] GitHub Pages: Getting Started, Migrating, etc. #260

gadicc commented Apr 26, 2016 •

edited

Loading

gadicc commented Apr 26, 2016

gadicc commented Apr 26, 2016

hedgerh commented Apr 26, 2016

hedgerh commented Apr 26, 2016

tsaiDavid commented Apr 26, 2016

hedgerh commented Apr 26, 2016

tsaiDavid commented Apr 26, 2016

gadicc commented Apr 26, 2016

gadicc commented May 3, 2016

gadicc commented May 6, 2016 •

edited

Loading

gaearon commented May 6, 2016

hedgerh May 11, 2016

gadicc May 11, 2016

hedgerh May 11, 2016

gadicc May 11, 2016

hedgerh commented May 11, 2016

gadicc commented May 11, 2016 •

edited

Loading

hedgerh commented May 11, 2016

hedgerh commented May 11, 2016

calesce commented Feb 27, 2017


		This tutorial assumes that you already have a working Webpack configuration and `WebpackDevServer` compiles and serves your code. If youʼd rather play with a ready-made example, try <a href="https://github.com/gaearon/react-hot-boilerplate" target="_blank">react-hot-boilerplate</a>.
		## Boilerplate Example


		XXX cleanup, details
		If you only render on the client, this is the easier option and quicker to setup. The key aspect of this configuration is that when creating a `new WebpackDevServer`, you need to specify `hot: true` as an option. For example, you can add an entirely new file called `server.js` and simply include the [server provided in the boilerplate](https://github.com/gaearon/react-hot-boilerplate/blob/master/server.js){:target="_blank"}.

[WIP] GitHub Pages: Getting Started, Migrating, etc. #260

[WIP] GitHub Pages: Getting Started, Migrating, etc. #260

Conversation

gadicc commented Apr 26, 2016 • edited Loading

gadicc commented Apr 26, 2016

gadicc commented Apr 26, 2016

hedgerh commented Apr 26, 2016

hedgerh commented Apr 26, 2016

tsaiDavid commented Apr 26, 2016

hedgerh commented Apr 26, 2016

tsaiDavid commented Apr 26, 2016

gadicc commented Apr 26, 2016

gadicc commented May 3, 2016

gadicc commented May 6, 2016 • edited Loading

gaearon commented May 6, 2016

hedgerh May 11, 2016

Choose a reason for hiding this comment

gadicc May 11, 2016

Choose a reason for hiding this comment

hedgerh May 11, 2016

Choose a reason for hiding this comment

gadicc May 11, 2016

Choose a reason for hiding this comment

hedgerh commented May 11, 2016

gadicc commented May 11, 2016 • edited Loading

hedgerh commented May 11, 2016

hedgerh commented May 11, 2016

calesce commented Feb 27, 2017

gadicc commented Apr 26, 2016 •

edited

Loading

gadicc commented May 6, 2016 •

edited

Loading

gadicc commented May 11, 2016 •

edited

Loading