-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a development environment setup tutorial for contributors (Asciidoc) #40
Comments
…ter formatting, and whole new explanation of how to setup a full development environment with IDEA that supports break-point usage, code hotswap, and automated deployment. This is in support of #40 where we will eventually move all of this information into an asciidoc development guide
@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. |
Hi @angrygreenfrogs , it's OK, reviewing it and looks great thus far, will be merged today... so leave it like that :) |
@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? |
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. |
@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 ? |
No description provided.
The text was updated successfully, but these errors were encountered: