improve the repository's layout (openshift#1154)

Signed-off-by: yuexiao-wang <[email protected]>

Author: yuexiao-wang

README.md

@@ -76,7 +76,7 @@ for more information.
 
 Our goal is to have extensive use-case and functional documentation.
 
-See [here](./docs/v1) for [documentation](./docs/v1).
+See [here](./docs/v1) for detailed documentation.
 
 See [here](https://github.com/kubernetes-incubator/service-catalog/wiki/Examples) for examples and
 [here](https://github.com/openservicebrokerapi/servicebroker/blob/master/gettingStarted.md) for
@@ -91,7 +91,7 @@ project.
 
 ### Contributing
 
-Interested in contributing?  Check out the [documentation](./CONTRIBUTING.md).
+Interested in contributing?  Check out the [contributing] documentation(./CONTRIBUTING.md).
 
 Also see the [developer's guide](./docs/devguide.md) for information on how to
 build and test the code.

docs/devguide.md

@@ -21,6 +21,9 @@ layout:
     ├── .glide                  # Glide cache (untracked)
     ├── bin                     # Destination for binaries compiled for linux/amd64 (untracked)
     ├── build                   # Contains build-related scripts and subdirectories containing Dockerfiles
+    ├── charts                  # Helm charts for deployment
+    │   └── catalog             # Helm chart for deploying the service catalog
+    │   └── ups-broker          # Helm chart for deploying the user-provided service broker
     ├── cmd                     # Contains "main" Go packages for each service catalog component binary
     │   └── apiserver           # The service catalog API server binary
     │   └── controller-manager  # The service catalog controller manager binary
@@ -31,11 +34,10 @@ layout:
     │   └── hack                # Non-build related scripts
     │   └── jenkins             # Jenkins configuration
     │   └── pkg                 # Contrib golang code
-    ├── charts                  # Helm charts for deployment
-    │   └── catalog             # Helm chart for deploying the catalog
-    │   └── ups-broker          # Helm chart for deploying the user-provided service broker
     ├── docs                    # Documentation
     ├── pkg                     # Contains all non-"main" Go packages
+    ├── plugin                  # Plugins for API server
+    ├── test                    # Integration and e2e tests
     └── vendor                  # Glide-managed dependencies
 
 ## Working on Issues