Upgrade documentation and supply examples

[adam-arold]

The documentation of this library is extremely lacking. There are no examples for even the simplest case of OAuth-based authentication for a GitHub app. The javadoc is basically non-existent. I can't figure out for example how can I use a client_id and client_secret for authentication.

Please improve this!

[alex-place]

I would just be happy if there was a commit/push example.

[bitwiseman]

@adam-arold @alex-place Any help you can offer would be great!

[martinvanzijl]

There is some good documentation on the project site: http://github-api.kohsuke.org/. There is a section for authentication: https://github-api.kohsuke.org/githubappflow.html.

@bitwiseman Maybe we can make this more prominent, by e.g. linking to it on the Wiki?

[martinvanzijl]

NOTE: Site content is also available in “src/site/”. You can compile this locally and view it in a web browser.

[familrodrigues]

hi @bitwiseman, I can pick up few use cases for documentation with examples. To start with may be have documentation created around - Creation of repository under an org, Clone a repository, creation of branches etc.. However, this issue seems to be very broad asking for complete upgradation on documentation.. how do we go about this?

[bitwiseman]

@familrodrigues It is up to you how you want to go about this. I'd suggest you just submit PRs as you go. We don't need a bunch of separate tickets or anything.