Merge pull request #41 from dimitraz/small-tweaks

Small tweaks

Author: maleck13

CONTRIBUTING.adoc renamed to .github/CONTRIBUTING.md

@@ -1,77 +1,77 @@
-= Contributing to the mobile CLI
+# Contributing to the mobile CLI
 
 This document explains how to set up a development environment and get involved with Mobile CLI project.
 
-Before anything else, https://help.github.com/articles/fork-a-repo/[fork] the Mobile CLI project.
+Before anything else, [fork](https://help.github.com/articles/fork-a-repo/) the Mobile CLI project.
 
-== Tools We use
+## Tools We use
 
 * Git
 * Go
 * Make
 
-== Set Up OpenShift
+## Set Up OpenShift
 
 The Mobile CLI targets Kubernetes and is intended to be developed against a running Kubernetes cluster,
 we use OpenShift as our Kubernetes distribution. The Mobile CLI is intended to help you work with Mobile Services running ontop of OpenShift.
-To provision these services, we levarage the https://github.com/kubernetes-incubator/service-catalog[Service Catalog] and the https://github.com/openshift/ansible-service-broker[Ansible Service Broker].
-To help get this infrastructure set up there is a https://github.com/aerogear/mobile-core#installing-from-a-development-release[ansible based installer] provided.
+To provision these services, we levarage the [Service Catalog](https://github.com/kubernetes-incubator/service-catalog) and the [Ansible Service Broker](https://github.com/openshift/ansible-service-broker).
+To help get this infrastructure set up there is a [ansible based installer](https://github.com/aerogear/mobile-core#installing-from-a-development-release) provided.
 
-== Clone the repositiory
+## Clone the repositiory
 
 As we are using Go, the path you clone this repo into is important.
 
 * create the directory `mkdir -p $GOPATH/src/github.com/aerogear`
-* clone the repo `cd $GOPATH/src/github.com/aerogear && git clone git@github.com:aerogear/mobile-CLI.git`
-* add your own fork as the upstream target `git add remote upstream <your fork>`
+* clone the repo `cd $GOPATH/src/github.com/aerogear && git clone git@github.com:aerogear/mobile-CLI.git`
+* add your own fork as the upstream target `git add remote upstream <your fork>`
 
-== Building the Mobile CLI
+## Building the Mobile CLI
 
 To build the CLI locally you can run `make build` this command will run a set of checks and the unit tests before compiling the binary and outputting it into the current directory,
 if you only want to build the binary itself you can simply run `make build_binary`.
 Once built, you can access this binary and use it from the command line `./mobile`
 Remember however that the CLI is intended as a Kubernetes plugin so expects to find kube configuration in `~/.kube/config`. If you have setup OpenShift this should
 already be in place.
 
-== Submitting changes to the Mobile CLI
+## Submitting changes to the Mobile CLI
 
-=== Before making a pull request
+### Before making a pull request
 
 There are a few things you should keep in mind before creating a PR.
 
-* New code should have corresponding unit tests. An example of how we approach unit testing can be found in https://github.com/aerogear/mobile-CLI/blob/master/pkg/cmd/clients_test.go[clients_test.go].
+* New code should have corresponding unit tests. An example of how we approach unit testing can be found in [clients_test.go](https://github.com/aerogear/mobile-CLI/blob/master/pkg/cmd/clients_test.go).
 
-* Ensure for new commands to read the https://github.com/aerogear/mobile-CLI/doc/adding_new_cmd.md[adding a new command] doc before hand.
+* Ensure for new commands to read the [adding a new command](https://github.com/aerogear/mobile-CLI/doc/adding_new_cmd.md) doc before hand.
 
-* You Must run ```make build``` before creating the PR and ensure it must execute with no errors.
+* You must run ```make build``` before creating the PR and ensure it must execute with no errors.
 
 * When needed, provide an explanation of the command and the expected output to help others that may review and test the change.
 
-=== Making a pull request
+### Making a pull request
 
-Make a https://help.github.com/articles/using-pull-requests[pull request (PR)] in the standard way.
+Make a [pull request (PR)](https://help.github.com/articles/using-pull-requests) in the standard way.
 
 Use [WIP] at the beginning of the title (ie. [WIP] Add feature to the CLI) to mark a PR as a Work in Progress.
 
-If you are not a member of the https://github.com/aerogear[aerogear org], the build job will pause for approval from a trusted approver.
+If you are not a member of the [aerogear org](https://github.com/aerogear), the build job will pause for approval from a trusted approver.
 Anyone who can login to Jenkins can approve.
 
 Your PR will then be reviewed, questions may be asked and changes requested.
 
 Upon successful review, someone will approve the PR in the review thread. Depending on the size of the change, we may wait for 2 LGTM from reviewers before merging.
 
 
-=== Major features
+### Major features
 
 The aerogear community uses a proposal process when introducing a major feature in order to encourage collaboration and building the best solution.
 
 Major features are things that take about 2 weeks of development or introduce disruptive changes to the code base.
 
-Start the proposal process by reviewing the https://github.com/aerogear/proposals/blob/master/template.md[proposal template]. Use this document to guide how to write a proposal. Then, submit it as a pull request where the community will review the plan.
+Start the proposal process by reviewing the [proposal template](https://github.com/aerogear/proposals/blob/master/template.md). Use this document to guide how to write a proposal. Then, submit it as a pull request where the community will review the plan.
 
 The proposal process also requires two approvals from the community before merging.
 
-== Stay in touch
+## Stay in touch
 
 * IRC: Join the conversation on Freenode: #aerogear
-* Email: Subscribe to the https://github.com/aerogear/mobile-CLI/doc/adding_new_cmd.md[aerogear mailing list]
+* Email: Subscribe to the [aerogear mailing list](https://lists.jboss.org/mailman/listinfo/aerogear-dev)

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-**This form is for bug reports and feature requests. Major features will go through a [proposal process](https://github.com/aerogear/mobile-cli/blob/master/CONTRIBUTING.adoc).**
+**This form is for bug reports and feature requests. Major features will go through a [proposal process](https://github.com/aerogear/mobile-cli/blob/master/.github/CONTRIBUTING.md).**
 
 > # Feature:
 > # Bug:

Readme.md renamed to README.md

@@ -1,17 +1,17 @@
-## The Mobile Cli is a standalone cli that can also be used a kubectl / oc plugin
+## The Mobile CLI is a standalone CLI that can also be used a kubectl / oc plugin
 
 ## Note this is still under construction and not yet fit for use
 
-The mobile cli focuses on a small set of commands to empower mobile focused developers to consume and take full advantage of the RedHat mobile suite
+The mobile CLI focuses on a small set of commands to empower mobile focused developers to consume and take full advantage of the RedHat mobile suite
 of services ontop of Kubernetes / OpenShift. 
 
 It uses a language familiar to mobile developers and abstracts away some of the complexity of dealing with Kubernetes / OpenShift which can be 
 initially daunting and overwhelming.
 
 ### Examples
 Note not all of these commands currently exist but are present below to show the general concept
-```
 
+```
 mobile get services
 
 mobile provision fh-sync
@@ -23,8 +23,8 @@ mobile create integration fh-sync keycloak
 mobile create clientbuild <MobileClientID> <Git_Source_Url> [buildName]
 
 mobile get buildartifact <clientBuildID> 
-
 ``` 
+
 ### Checkout 
 
 ```
@@ -39,15 +39,16 @@ git clone https://github.com/aerogear/mobile-cli
 glide install
 make build
 ```
-To test run
+
+To test, run:
 
 ```
 ./mobile
 ```
 
 ### Build for APB usage
 
-To use the mobile-cli inside an APB container it needs to be compiled for the linux/amd64 platform:
+To use the mobile CLI inside an APB container it needs to be compiled for the linux/amd64 platform:
 
 ```
 make build_linux
@@ -57,20 +58,19 @@ make build_linux
 
 ### Pre req
 
-- have a local kubernetes or oc cluster via something like minikube or oc cluster up
+- Have a local kubernetes or oc cluster via something like minikube or oc cluster up
 - Install glide (https://github.com/Masterminds/glide), e.g. `brew install glide`
 
 ### Setup the Custom Resource Definition
 
 ```
 oc login -u system:admin
 oc create -f artifacts/mobileclient_crd.yaml
-
 ```
 
-In OpenShift, add the following to the edit and admin roles
+In OpenShift, add the following to the edit and admin roles:
 
-``` 
+```yml
 - apiGroups:
   - mobile.k8s.io
   attributeRestrictions: null
@@ -85,38 +85,39 @@ In OpenShift, add the following to the edit and admin roles
   - update
   - watch
 ```
-You can do this via the edit command in oc
-```
+
+You can do this via the edit command in oc:
+
+```bash 
 oc edit clusterrole admin # add the above and save
 oc edit clusterrole edit # add the above and save
 ```
 
 ### Setup the plugin
 
 - have the [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) command line tool or the [oc command line tool](https://docs.openshift.org/latest/cli_reference/get_started_cli.html#installing-the-cli) already installed
-- It should be version k8s version 1.8 or OpenShift 3.7 or later
+- it should be version k8s version 1.8 or OpenShift 3.7 or later
 - create a new dir ```mkdir -p ~/.kube/plugins/mobile```  
 - copy the plugin.yaml to the dir ```cp ./artifacts/cli_plugin.yaml ~/.kube/plugins/mobile```
-- install the mobile cli binary onto your $PATH
+- install the mobile CLI binary onto your $PATH
 
 ### Basic usage
 
 To access the plugin you can use the following command:
 ```kubectl plugin mobile <command>```
 
 You can also use it standalone as it will pick up on your kube configuration:
-
 ```mobile --namespace=mine <command>``` notice we pass the namespace here.
 
 **Passing flags**
 
-To pass flags when using the plugin ensure to use the ```--``` option 
-
+To pass flags when using the plugin ensure to use the ```--``` option:
 ```kubectl plugin mobile -- create client --<someflag> ```
 
 
 ## Design
-The design of the cli API attempts to give a familiar feel to users familiar wil the kubectl and oc CLIs. 
+
+The design of the CLI API attempts to give a familiar feel to users familiar wil the kubectl and oc CLIs. 
 It is also intended to use parlance familiar to mobile developers in order to help them become more productive
 and avoid needing to know the innards of various kubernetes resources.
 
@@ -134,7 +135,7 @@ required in order to consume your mobile aware services from your mobile client.
 -  **ServiceConfig:** the Service Config stores information about a mobile aware service and is backed by a secret. This information is then used to populate your mobile client's config.
 This information could be anything but often is made up of values such as the URI of the service and perhaps some headers and configuration particular to that service.
 
-- **ClientBuild** the ClientBuild is backed by a regular BuildConfig however the cli will help you create this BuildConfig with as little effort as possible. Allowing you to focus on
+- **ClientBuild** the ClientBuild is backed by a regular BuildConfig however the CLI will help you create this BuildConfig with as little effort as possible. Allowing you to focus on
 just the mobile parts rather than needing to understand how to setup and manage a buildconfig and builds. For example, it will help you manage build credentials, and keys and ensure the build integrates
 seamlessly with the areogear mobile build farm .
 
@@ -209,3 +210,7 @@ stop
 
     - clientbuild <buildName>
                     
+
+## Contributing 
+
+Check the [`CONTRIBUTING.md`](https://github.com/aerogear/mobile-cli/blob/master/.github/CONTRIBUTING.md) file.