Update docs

Author: bzon

CONTRIBUTION.md CONTRIBUTING.mdCONTRIBUTION.md renamed to CONTRIBUTING.md

@@ -6,10 +6,13 @@
 	* [Requirements](#requirements)
 	* [Environment Variables and Test Data](#environment-variables-and-test-data)
 	* [Refresh Test Data](#refresh-test-data)
-	* [Branching](#branching)
 	* [Issue Tracker](#issue-tracker)
+	* [Branching](#branching)
+	* [Code Generator](#code-generator)
+	* [Good Commit Message Examples](#good-commit-message-examples)
 	* [Before Pushing your Commit](#before-pushing-your-commit)
-* [Custom Packages](#custom-packages)
+	* [Tips and Tricks](#tips-and-tricks)
+* [Custom Packages we are using](#custom-packages-we-are-using)
 * [Test Driven Development](#test-driven-development)
 * [How the Commands Authenticate](#how-the-commands-authenticate)
 * [Commands Pattern](#commands-pattern)
@@ -58,6 +61,14 @@ source testdata/credentials.sh
 testdata/seeder.sh
 ```
 
+### Issue Tracker
+
+[![Throughput Graph](http://graphs.waffle.io/devopsctl/gitlabctl/throughput.svg)](https://waffle.io/devopsctl/gitlabctl/metrics)
+
+* Ensure that you are working on an [Issue](https://github.com/devopsctl/gitlabctl/issues) 
+and is visible in [Waffle Issue Tracker](https://waffle.io/devopsctl/gitlabctl).
+* Ensure to create a branch for your Issue.
+
 ### Branching 
 
 * Branch name should be in the format of `{{issueNumber}}-{{shortTaskName}}`. 
@@ -66,13 +77,17 @@ Example: `19-add-group-get-cmd`.
 Use `git pull --rebase origin master` or `git pull --rebase origin branchName` 
 as much as possible.
 
-### Issue Tracker
+### Code Generator
 
-[![Throughput Graph](http://graphs.waffle.io/devopsctl/gitlabctl/throughput.svg)](https://waffle.io/devopsctl/gitlabctl/metrics)
+Once you get the basics of creating a gitlabctl command, you will find out that most code are repeatable. 
+This is where the `gitlabctl gencode` commands can be of help.
 
-* Ensure that you are working on an [Issue](https://github.com/devopsctl/gitlabctl/issues) 
-and is visible in [Waffle Issue Tracker](https://waffle.io/devopsctl/gitlabctl).
-* Ensure to create a branch for your Issue.
+Please use it in for your own convenience. Feedback about this command is also appreciated!
+
+### Good Commit Message Examples
+
+* `new_group: fix known issue when printing output` - when patching an existing command
+* `Add new command get labels` - when adding a new command
 
 ### Before Pushing your Commit
 
@@ -86,7 +101,19 @@ community may be able to answer your questions.
 * If you are not changing code (e.g: updating docs or adding test data), 
 use __ci skip__ in commit message to [Skip TravisCI build](https://docs.travis-ci.com/user/customizing-the-build/#Skipping-a-build)
 
-## Custom Packages
+### Tips and Tricks
+
+Use `grm cmd subcmd` for ease of testing a command.
+* How: `alias grm='go run main.go'`
+* Example Usage: `grm get groups`
+
+Use `gt` for ease of running `go test`.
+
+* How: `alias gt='go test -v ./...'`
+* Example Usage: `gt -run NewGroup`
+
+
+## Custom Packages we are using
 
 * Gitlab api client - https://godoc.org/github.com/xanzy/go-gitlab 
 * Commandline flags - https://github.com/spf13/cobra 
@@ -105,6 +132,8 @@ Authenticate using environment variables.
 * Private token authentication - `GITLAB_PRIVATE_TOKEN` and `GITLAB_API_HTTP_URL`
 * OAuth2 token authentication - `GITLAB_OAUTH_TOKEN` and `GITLAB_API_HTTP_URL`
 
+Authenticate using `gitlabctl login` command.
+
 ## Commands Pattern
 
 The command chain format is inspired from `kubectl` or `oc` Verb -> Subject -> Flags.

README.md

@@ -24,7 +24,7 @@ gitlabctl completion -h
 
 ## Contributing
 
-Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTION.md) for the process for submitting pull requests to us.
+Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for the process for submitting pull requests to us.
 
 ## Gitlab Commands Available 
 ### Authentication 

docs/gitlabctl_gencode.md

@@ -0,0 +1,35 @@
+## gitlabctl gencode
+
+For gitlabctl developers only
+
+### Synopsis
+
+For gitlabctl developers only
+
+```
+gitlabctl gencode [flags]
+```
+
+### Options
+
+```
+  -f, --file string     command file name
+  -h, --help            help for gencode
+      --max-args int    command max accepted args
+  -n, --name string     command variable name
+  -p, --parent string   command parent variable name
+  -s, --short string    command short description
+  -u, --use string      command use
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.gitlabctl.yaml)
+```
+
+### SEE ALSO
+
+* [gitlabctl](gitlabctl.md)	 - Gitlab command-line interface
+
+###### Auto generated by spf13/cobra on 16-Jun-2018

docs/gitlabctl_new.md

@@ -22,7 +22,7 @@ Create a Gitlab resource
 ### SEE ALSO
 
 * [gitlabctl](gitlabctl.md)	 - Gitlab command-line interface
-* [gitlabctl new branch](gitlabctl_new_branch.md)	 - Create a new branch for a project repository
+* [gitlabctl new branch](gitlabctl_new_branch.md)	 - Create a new branch for a specified project
 * [gitlabctl new group](gitlabctl_new_group.md)	 - Create a new group by specifying the group name as the first argument
 * [gitlabctl new member](gitlabctl_new_member.md)	 - Create a new member by specifying the member name as the first argument
 * [gitlabctl new project](gitlabctl_new_project.md)	 - Create a new project by specifying the project name as the first argument

docs/gitlabctl_new_branch.md

@@ -1,21 +1,27 @@
 ## gitlabctl new branch
 
-Create a new branch for a project repository
+Create a new branch for a specified project
 
 ### Synopsis
 
-Create a new branch for a project repository
+Create a new branch for a specified project
 
 ```
 gitlabctl new branch [flags]
 ```
 
+### Examples
+
+```
+gitlabctl new branch project23 --name=release-x --ref=master
+```
+
 ### Options
 
 ```
   -h, --help          help for branch
-  -b, --name string   The name of the branch
-  -p, --ref string    The branch name or commit SHA to create branch from
+  -n, --name string   The name of the branch
+  -r, --ref string    The branch name or commit SHA to create branch from
 ```
 
 ### Options inherited from parent commands