vespene-io / _old_vespene

DISCONTINUED: a frozen fork will exist forever at mpdehaan/vespene
http://vespene.io/
Apache License 2.0
650 stars 66 forks source link

docs: Detail the setup process #77

Closed varunchopra closed 6 years ago

varunchopra commented 6 years ago

I think the setup process needs to be a bit more detailed and reformatted for readability.

Edit: TIL there's also http://docs.vespene.io/development_setup.html ;_;

mpdehaan commented 6 years ago

Hi,

This is really a lot of different things.

If you would like to discuss them I would suggest commenting on the docs topic on talk.vespene.io and I can go into detail on each. The forum is for feedback and this queue is for bugs.

Regardless, some comments now:

The hostname is not public because without a SSL configuration it would be an insecure default. This can be provided through gunicorn or NGINX/Apache. That could possibly be added to the security guide.

I think most poeple know what those paths mean but I’m open to some clarification and thoughts from multiple readers are welcome. Vespene projects live in the database and .vespene files live in the source git repos.

Anyway if you can stop by the forum docs feedback thread that would be great!

I would not spend time on rewriting my docs - I’m very opinionated there and these took weeks to write - and there is a chance edits may lose some detail.