search

RestComm / gmlc

Restcomm Location Server
http://www.restcomm.com/
GNU Affero General Public License v3.0
17 stars 40 forks source link

Add a development environment setup tutorial for contributors (Asciidoc) #40

Open FerUy opened 8 years ago

angrygreenfrogs commented 8 years ago

@FerUy I have a PR that will be helpful on this issue, which I've just created and hope you can review/accept.

I sent the PR to master, but let me know if you want the work flow to be for these to go through gmlc1.0.

FerUy commented 8 years ago

Hi @angrygreenfrogs , it's OK, reviewing it and looks great thus far, will be merged today... so leave it like that :)

angrygreenfrogs commented 8 years ago

@FerUy I'm a little uncertain about where install and developer docs should go? I've been looking at some of the other projects, and there's a mixture of github wiki and also docs located on documentation.telestax.com (I assume this is from the generated asciidocs?)

https://github.com/RestComm/Restcomm-Connect/wiki/Contribute-to-RestComm

http://documentation.telestax.com/connect/

Is there any best practice for what belongs where?

FerUy commented 8 years ago

Hi @angrygreenfrogs , your assumption is correct, documents located on http://documentation.telestax.com/ are generated from the Asciidocs.

For developers/open source collaborators, I would say to place docs in Github.

deruelle commented 8 years ago

@angrygreenfrogs Let's create a contributors directory under https://github.com/RestComm/gmlc/tree/master/docs and add asciidoc documentation for contributors similarly to how we do it for userguide/adminguide for regular users. Makes sense ?