Skip to content
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

Open
FerUy opened this issue Jun 28, 2016 · 5 comments
Open
Assignees

Comments

@FerUy
Copy link
Contributor

FerUy commented Jun 28, 2016

No description provided.

@FerUy FerUy added this to the 1.0.0 milestone Jun 28, 2016
@FerUy FerUy self-assigned this Jun 28, 2016
@FerUy FerUy changed the title Add a development environment setup tutorial (Asciidoc) Add a development environment setup tutorial for contributors (Asciidoc) Jun 28, 2016
angrygreenfrogs added a commit that referenced this issue Jul 19, 2016
…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
@angrygreenfrogs
Copy link
Collaborator

@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
Copy link
Contributor Author

FerUy commented Jul 20, 2016

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

@angrygreenfrogs
Copy link
Collaborator

@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
Copy link
Contributor Author

FerUy commented Jul 21, 2016

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
Copy link
Member

@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 ?

@deruelle deruelle modified the milestones: 2.0.0, 1.0.0 Jul 22, 2016
@FerUy FerUy modified the milestones: 3.0.0, 2.0.0 Sep 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants