Mastodon: Main README developer documentation

[wavebeem]

The main README does not seem to link to https://github.com/tootsuite/documentation/blob/master/README.md which appears to be the primary documentation at this point.

Additionally, the main README has a Development with Vagrant section, but the primary documentation mentions that developing with Docker is not recommended, so I think we should remove that section too.

I can say that personally this confusion cost me almost four hours of time spent in confusion before I found the real docs, after which I was up and developing locally in like 10 minutes.

---

• [x] I searched or browsed the repo’s other issues to ensure this is not a duplicate.

[hendotcat]

Wait, I'm confused about this one 😅

I set up my development environment with Vagrant cos of that README entry, and it didn't involve any Docker stuff. Wait, omg, I get it: the main docs refer to the Vagrant way as an "alternative"! Didn't realise until just now that I may have set my dev instance up in a non-standard way 😮

Probably worth getting this cleared up then, yeah!

[wavebeem]

Hmm, maybe I should've used vagrant then? I'm currently running Postgres and whatnot on my actual laptop (which I'd frankly rather not have to do... I don't want DB services turning on when I boot my laptop).

[wavebeem]

It make more sense if the main README to this project was more of an overview:

1. What is Mastodon
2. Link to running locally for development
3. Link to running in production
4. Contributing
5. Extra credits

Right now the README is quite large and it seems confusing to maintain docs in two places.

[ashfurrow]

Since https://github.com/tootsuite/mastodon/pull/2026 has been merged, I'm going to close this issue. @wavebeem if this hasn't been solved to your satisfaction, please re-open. Thanks!

[wavebeem]

I think we need a link to the development guide in the main README still.

Also I don't think I have permission to re-open an issue, fyi :)

[ashfurrow]

Oh, I apologize, I thought GitHub gave the person who opened the issue permissions to re-open it. Are you free to open a PR adding a link to the dev guide to the readme?

[wavebeem]

Yeah I'll try and remember to submit one tomorrow.

On Mon, Apr 24, 2017, 23:06 Ash Furrow [e-mail] wrote:

Reopened #1830 https://github.com/tootsuite/mastodon/issues/1830.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/tootsuite/mastodon/issues/1830#event-1056026461, or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAKyr1VxjLO_7dISjEvXYoDaOtzkXAlPks5rzY11gaJpZM4M-Rhp
.