ring icon indicating copy to clipboard operation
ring copied to clipboard

Document improvement for development and production setup

Open laliluna opened this issue 7 years ago • 3 comments

I struggled to setup ring for development and production, as there are so many options.

I tried to compile what I found into two pages https://github.com/laliluna/ring/wiki/Setup-for-development and https://github.com/laliluna/ring/wiki/Setup-for-production

In addition I structured the Home page to make it a bit easier to read. https://github.com/laliluna/ring/wiki

The examples are more detailed to make it easier for unexperienced user to setup ring.

Let me know, if this is useful.

laliluna avatar Nov 11 '17 22:11 laliluna

Thanks for the documentation. I like the idea of a more real-world setup guide, but I noticed a few errors or unidiomatic examples when I was skimming the guides you had. I'm also not sure the Ring wiki is necessarily the right place for them.

weavejester avatar Nov 12 '17 03:11 weavejester

I would be happy, to improve what I created. In general I like the style of JavaScript projects providing all information on the project page. This is why I thought the right place in the wiki. Just let me know, how you would like to proceed.

laliluna avatar Nov 12 '17 13:11 laliluna

I removed pages with redundant information, updated an old ring on the getting startet page. There had been multiple pages on params and response generation The home and getting starting shows the latest clojar version now. I put every step into a separate commit to make this a bit more transparent. Let me know if anything can be improved.

laliluna avatar Nov 18 '17 22:11 laliluna