Hi Xamfy and thanks for bringing this up! the setup guide for users has to be different from developers because developers need to clone several repositories and import them into their editor.
The rest looks good! We also need a quick-start for new users that explains how to quickly do the basic operations with openwisp2 (which should follow the setup section for users) and a tutorials section. @Hargoving yes we python-sphinx is the format we use. Setup for users should be mainly ansible-openwisp2 and openwisp-config (OpenWRT). Setup for developers should explain how to clone/compile/run each module, it will be a bit more complex but we can divide this into 2 groups: python/django and openwrt. 3: some examples of prewritten contribution guidelines are here: http://openwisp.org/thecode.html http://netjsonconfig.openwisp.org/en/stable/general/contributing.html Whom of you wants to start with creating the sphinx project? Anything else you feel confident to start with? You can use this repo (fork it for now and send PR when ready, will give you write access later): https://github.com/openwisp/openwisp2-docs That would help a lot! Federico On Tue, Oct 31, 2017 at 2:57 PM Hargovind Singh Arora < [email protected]> wrote: > It's a Great idea. It will provide an efficient way for new contributors > to connect to the organization easily and quickly. > I will work on this and have few questions like - > 1. Is the documentation to be created through sphinx? > 2. In "Setup" which project our we referring to? > 3. Is there any prewritten contributing guidelines? > > Please guide! :) > > -- > You received this message because you are subscribed to the Google Groups > "OpenWISP" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "OpenWISP" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
