Update documentations

Author: Sazon, John Bryan J

README.md

@@ -7,13 +7,17 @@
 
 Be a rockstar and efficiently manage your team's gitlab.org or [self-hosted Gitlab](https://about.gitlab.com/installation/) projects, groups, users and other resources.
 
-Tested with [__Gitlab 11.0.3__](https://about.gitlab.com/2018/07/05/gitlab-11-0-3-released/)
+Tested with [__Gitlab 11.1__](https://about.gitlab.com/2018/07/22/gitlab-11-1-released/).
 
 ## Getting Started
 
-Please see [Commands Manual](https://devopsctl.github.io/gitlabctl/) for a nice documentation of this project.
+Complete the [installation](#installation) guide below and then follow the [quickstart](#quickstart) guide.
 
-## Installing
+If you are hooked, please visit the awesome [Project Github site](https://devopsctl.github.io/gitlabctl/) to read the full manual of each command.
+
+If you just want to quickly check what are the available commands, go to [Gitlab Commands Available](#gitlab-commands-available) in this page.
+
+## Installation
 
 Get the download link of your preferred platform binary from [RELEASES](https://github.com/devopsctl/gitlabctl/releases).
 
@@ -49,7 +53,7 @@ gitlabctl completion -h
 Using `gitlabctl login` to fetch personal access token
 
 ```bash
->> gitlabctl login
+gitlabctl login
 >> Enter gitlab host url: http://localhost:10080
 >> Enter gitlab username: root
 >> Enter gitlab password: *****
@@ -62,14 +66,23 @@ Using environment variables. See `gitlabctl -h`
 
 Use __-h__ flag when possible. 
 
-`gitlabctl [command] -h` or `gitlabctl [command] [subcommand] -h`
+```bash
+gitlabctl [command] -h
+```
+
+or
+
+```bash
+gitlabctl [command] [subcommand] -h
+```
 
 ### Usage Examples
 
 Fetching resources with using `--output, -o` formatter flag.
 
 ```bash
->> gitlabctl get groups
+gitlabctl get groups
+
 +----+------------------+------------------------------------------------+-----------+
 | ID |       PATH       |                      URL                       | PARENT ID |
 +----+------------------+------------------------------------------------+-----------+
@@ -82,8 +95,11 @@ Fetching resources with using `--output, -o` formatter flag.
 +----+------------------+------------------------------------------------+-----------+
 ```
 
+View command outout in __json__.
+
 ```bash
->> gitlabctl get groups -o json
+gitlabctl get groups -o json
+
 [
  {
   "id": 13,
@@ -120,8 +136,11 @@ Fetching resources with using `--output, -o` formatter flag.
  ]
 ```
 
+View the command output in __yaml__.
+
 ```bash
->> gitlabctl get groups -o yaml
+gitlabctl get groups -o yaml
+
 - avatar_url: ""
   description: Updated by go test by id
   full_name: Group1
@@ -152,23 +171,19 @@ Fetching resources with using `--output, -o` formatter flag.
   web_url: http://localhost:10080/groups/Group2
 ```
 
-Creating resources.
+Create gitlab resources.
 
 ```bash
 # create a group
->> gitlabctl new group devopsctl
+gitlabctl new group devopsctl
 
 # create a project under devopsctl group
->> gitlabctl new project gitlab-cli --namespace=devopsctl
+gitlabctl new project gitlab-cli --namespace=devopsctl
 
 # create a new user with username john
->> gitlabctl new user john --name="John Smith" --password="john123456" [email protected] --reset-password 
+gitlabctl new user john --name="John Smith" --password="john123456" [email protected] --reset-password 
 ```
 
-## Contributing
-
-Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for the process for submitting pull requests to us.
-
 ## Gitlab Commands Available 
 ### Authentication 
 
@@ -207,14 +222,14 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
 * [x] `edit branch [branch name] [--project] [--protect] [flags]`
 * [x] `edit branch [branch name] [--project] [--unprotect] [flags]`
 
-### Project/Repository Tags
+### Project/Repository Tags and Releases
 
 * [x] `get tags [project id or project path] [flags]`
 * [x] `describe tag [tag name] [--project] [flags]`
 * [x] `new tag [tag name] [--project] [flags]`
 * [x] `delete tag [tag name] [--project]`
-* [x] `new release [description] [--project] [flags]`
-* [ ] `edit release [description] [--project] [flags]`
+* [x] `new release [tag name] [--project] [flags]`
+* [x] `edit release [tag name] [--project] [flags]`
 
 ### Project Hooks
 
@@ -251,3 +266,7 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
 * [x] `edit member [username] --from-project [flags]`
 * [x] `delete all-members --from-project`
 
+## Contributing
+
+Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for the process for submitting pull requests to us.
+

docs/gitlabctl_edit.md

@@ -27,5 +27,6 @@ Update or patch a Gitlab resource
 * [gitlabctl edit member](gitlabctl_edit_member.md)	 - Edit a member by specifying the member name as the first argument
 * [gitlabctl edit project](gitlabctl_edit_project.md)	 - Edit a project by specifying the project id or path and using flags for fields to modify
 * [gitlabctl edit project-hook](gitlabctl_edit_project-hook.md)	 - Edit a project hook by specifying the project id or path and using flags for fields to modify
+* [gitlabctl edit release](gitlabctl_edit_release.md)	 - Update the release note of a project's release
 * [gitlabctl edit user](gitlabctl_edit_user.md)	 - Modify a user by specifying the id or username and using flags for fields to modify
 

docs/gitlabctl_edit_release.md

@@ -0,0 +1,37 @@
+## gitlabctl edit release
+
+Update the release note of a project's release
+
+### Synopsis
+
+Update the release note of a project's release
+
+```
+gitlabctl edit release [flags]
+```
+
+### Examples
+
+```
+gitlabctl edit release v1.0 --project=groupx/myapp --description="Updated Release Note"
+```
+
+### Options
+
+```
+  -d, --description string   Release note
+  -h, --help                 help for release
+  -p, --project string       The name or ID of the project
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.gitlabctl.yaml)
+  -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
+```
+
+### SEE ALSO
+
+* [gitlabctl edit](gitlabctl_edit.md)	 - Update or patch a Gitlab resource
+

docs/gitlabctl_new.md

@@ -27,7 +27,7 @@ Create a Gitlab resource
 * [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
 * [gitlabctl new project-hook](gitlabctl_new_project-hook.md)	 - Create a new project hook by specifying the project id or project path as the first argument
-* [gitlabctl new release](gitlabctl_new_release.md)	 - Create a new release for a specified project
+* [gitlabctl new release](gitlabctl_new_release.md)	 - Create a new release for the specified project's tag
 * [gitlabctl new ssh-key](gitlabctl_new_ssh-key.md)	 - Upload or create ssh key for a gitlab user
 * [gitlabctl new tag](gitlabctl_new_tag.md)	 - Create a new tag for a specified project
 * [gitlabctl new user](gitlabctl_new_user.md)	 - Create a new user by specifying the username as the first argument

docs/gitlabctl_new_release.md

@@ -1,10 +1,10 @@
 ## gitlabctl new release
 
-Create a new release for a specified project
+Create a new release for the specified project's tag
 
 ### Synopsis
 
-Create a new release for a specified project
+Create a new release for the specified project's tag
 
 ```
 gitlabctl new release [flags]
@@ -13,16 +13,19 @@ gitlabctl new release [flags]
 ### Examples
 
 ```
-# create release from v1.0 tag of project groupx/myapp
-gitlabctl new release sample --project=groupx/myapp --tag=v1.0
+# ensure to create the tag where the release will be created from
+gitlabctl new tag v1.0 --ref=master --project=groupx/myapp
+
+# create the release
+gitlabctl new release v1.0 --project=groupx/myapp --description="Sample Release Note"
 ```
 
 ### Options
 
 ```
-  -h, --help             help for release
-  -p, --project string   The name or ID of the project
-  -t, --tag string       The name of a tag
+  -d, --description string   The release note or description
+  -h, --help                 help for release
+  -p, --project string       The name or ID of the project
 ```
 
 ### Options inherited from parent commands

docs/gitlabctl_new_tag.md

@@ -15,14 +15,21 @@ gitlabctl new tag [flags]
 ```
 # create tag from master branch for project groupx/myapp
 gitlabctl new tag v2.0 --project=groupx/myapp --ref=master
+
+# create a tag and create a release from it
+gitlabctl new tag v2.1 --project=groupx/myapp --ref=master --description="Released!"
+
+# NOTE: You can also use 'gitlabctl new release' to create a release separately.
 ```
 
 ### Options
 
 ```
-  -h, --help             help for tag
-  -p, --project string   The name or ID of the project
-  -r, --ref string       The branch name or commit SHA to create branch from
+  -d, --description string   Create a release from the git tag with the description as the release note
+  -h, --help                 help for tag
+  -m, --message string       Creates annotated tag
+  -p, --project string       The name or ID of the project
+  -r, --ref string           The branch name or commit SHA to create branch from
 ```
 
 ### Options inherited from parent commands