Update example.html docs with HTTP server section and info about pushState support

[wjcrowcroft]

I've noticed it's pretty common for tutorials and docs everywhere to explain HTML5 History and then say "Oh yeah btw pushState won't work unless you redirect everything to index.html lol" - and then leave it at that. I did some searching and realised nobody's actually explained how to do it in Apache, which is what a huge number of people use..

So I published a quick guide about setting up .htaccess on Apache for pushState - I think it's worthwhile to include this info in the docs, along with other common server configs.

Personally I was searching for this info for ages so I hope it can help out a few other people...

In this pull request I've added a section to the example.html docs for HTTP Server Setup, which would contain all the info people need to get their apps running, locally and in production - this would cover supporting pushState URLs, as well as all the other bits and bobs needed for various servers.

It's cool with me if you want to change the text, restructure it, remove the link to the article or merge it into another section - seems to fit well, but I didn't have a style to base it on since all the other sections are placeholders :o)

I've also added a note and link in the readme with a bit about this, where it was already being mentioned (again, feel free to change.)

Ok! that's all for now.

[tbranyen]

Sorry to make you do all this, but i think it'll mostly carry over... we're gonna need to move this to the Wiki. I've been thinking about it and we should have a special page there. I can look into it tomorrow if its something you don't want to do.

[wjcrowcroft]

No worries, Any reason you don't want to put it in the docs? I imagine a lot more people will read those than will read the wiki. But yeah, happy to move it to wherever!

[tbranyen]

Mainly because apache isn't the only webserver out there and I intend on having full sample configs for the major servers, doing so will clutter the readme/tutorial. I definitely think linking to the Wiki page from readme/tutorial is worth doing.

I'm thinking about deployments and pushState and showing how its possible to do it in a server config is a great way to get the developer thinking about their own strategy.

[wjcrowcroft]

Ok, sounds good to me - let me know where in the Wiki it should go, when you're ready, and I'll morph it in.

[paulirish]

👍 to making this more obvious.