Merge pull request #739 from oracle/edits

minor edits, fix broken link

Author: rjeberhard

README.md

@@ -52,13 +52,13 @@ maintained for one release after a replacement is available.
 
 # About this documentation
 
-This documentation includes sections aimed at different audiences.  To help you find what you are looking for more easily,
+This documentation includes sections targeted to different audiences.  To help you find what you are looking for more easily,
 please consult this table of contents:
 
-* The [Quick start guide](site/quickstart.md) explains how to just get the operator running quickly, using all the defaults, nothing special.
-* The [User guide](site/user-guide.md) contains detailed information for users of the operator, including how to install and configure it,
+* The [Quick start guide](site/quickstart.md) explains how to quickly get the operator running, using the defaults, nothing special.
+* The [User guide](site/user-guide.md) contains detailed usage information, including how to install and configure the operator,
   and how to use it to create and manage WebLogic domains.  
-* Our [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
+* The [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
   various tasks related to the operator.
 * The [Developer guide](site/developer.md) provides details for people who want to understand how the operator is built, tested, and so on. Those who wish to contribute to the operator code will find useful information here.  This section also includes
   API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs.
@@ -81,7 +81,7 @@ The [User guide](site/user-guide.md) provides detailed information about all asp
 
 # Samples
 
-Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code we provide.
+Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code.
 
 # Need more help? Have a suggestion? Come and say "Hello!"
 
@@ -98,17 +98,17 @@ See [Recent changes](site/recent-changes.md) for changes to the operator, includ
 
 Developers interested in this project are encouraged to read the [Developer guide](site/developer.md) to learn how to build the project, run tests, and so on.  The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kubernetes API.
 
-Please take a look at our [wish list](https://github.com/oracle/weblogic-kubernetes-operator/wiki/Wish-list) to get an idea of the kind of features we would like to add to the operator.  Maybe you will see something you would like to contribute to!
+Please take a look at our [wish list](https://github.com/oracle/weblogic-kubernetes-operator/wiki/Wish-list) to get an idea of the kind of features we would like to add to the operator.  Maybe you will see something to which you would like to contribute!
 
 ## API documentation
 
 Documentation for APIs is provided here:
 
-* The operator provides a REST API that you can use to obtain information about the configuration and to initiate scaling actions. For details about how to use the REST APIs, see [Using the operator's REST services](site/rest.md).
+* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Using the operator's REST services](site/rest.md).
 
 * See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
 
-* [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
+* See the [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
 
 # Contributing to the operator
 

site/database.md

@@ -1,22 +1,22 @@
 
 # Running the Oracle Database in Kubernetes
 
-If you wish to run the Oracle Database inside your Kubernetes cluster, in order to place 
-your state store, leasing tables, etc., in that database, then you can use this 
-sample to install the database. 
+If you wish to run the Oracle Database inside your Kubernetes cluster, in order to place
+your state store, leasing tables, and such, in that database, then you can use this
+sample to install the database.
 
 You must configure your database to store its DB files
-on persistent storage.  Refer to your cloud vendor's documentation for details of 
+on persistent storage.  Refer to your cloud vendor's documentation for details of
 available storage providers and how to create a persistent volume and attach it to a pod.
 
-First create a namespace for the database: 
+First create a namespace for the database:
 
-``` 
+```
 kubectl create namespace database-namespace
 ```
 
 Next, create a file called `database.yml` with the following content.  Make sure you update the
-password field with you chosen administrator password for the database. 
+password field with your chosen administrator password for the database.
 
 ```
 apiVersion: extensions/v1beta1
@@ -97,7 +97,7 @@ and accept the license for the [Oracle database image](https://container-registr
 
 Create a Docker registry secret so that Kubernetes can pull the database image:
 
-``` 
+```
 kubectl create secret docker-registry regsecret \
         --docker-server=container-registry.oracle.com \
         [email protected] \
@@ -109,12 +109,12 @@ kubectl create secret docker-registry regsecret \
 
 Now use the following command to install the database:
 
-``` 
+```
 kubectl apply -f database.yml
 ```
 
 This will start up the database and expose it in the cluster at the following address:
 
-``` 
+```
 database.database-namespace.svc.cluster.local:1521
-```
+```

site/prepare-k8s.md

@@ -4,7 +4,7 @@
 
 ## Set up your Kubernetes cluster
 
-If you need help setting up a Kubernetes environment, check our [cheat sheet](site/k8s_setup.md).
+If you need help setting up a Kubernetes environment, check our [cheat sheet](k8s_setup.md).
 
 After creating Kubernetes clusters, you can optionally:
 * Create load balancers to direct traffic to backend domains.

site/quickstart.md

@@ -4,12 +4,12 @@ Use this quick start guide to create a WebLogic deployment in a Kubernetes clust
 These instructions assume that you are already familiar with Kubernetes.  If you need more detailed instructions, please
 refer to the [User guide](user-guide.md).
 
-> If you have an old version of the operator installed on your cluster you must remove
-  it before installing this version.  You should remove the deployment (for example `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
-  resource definition (for example `kubectl delete crd domain`).  If you do not remove
-  the custom resource definition you may see errors like this: 
-  
-    `Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml": 
+> If you have an older version of the operator installed on your cluster, you must remove
+  it before installing this version.  You should remove the deployment (for example, `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
+  resource definition (for example, `kubectl delete crd domain`).  If you do not remove
+  the custom resource definition you may see errors like this:
+
+    `Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml":
     the API version in the data (weblogic.oracle/v2) does not match the expected API version (weblogic.oracle/v1`
 
 ## Prerequisites
@@ -32,7 +32,7 @@ b.  Log in to the Docker Store from your docker client:
 ```
 $ docker login
 ```
-c.	Pull the operator image and tag it to the default image value of the operator:
+c.	Pull the operator image and tag it with the default image value of the operator:
 ```
 $ docker pull oracle/weblogic-kubernetes-operator:2.0-rc1
 $ docker tag oracle/weblogic-kubernetes-operator:2.0-rc1 weblogic-kubernetes-operator:2.0
@@ -170,9 +170,9 @@ $ cd kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image
 $ ./create-domain.sh -i my-inputs.yaml -o /some/output/directory -u username -p password -e
 ```
 
-You need to provide the WebLogic administration username and password in the `-u` and `-p` options
-respectively, as shown in the example.  If you specify the `-e` option, the script will generate the 
-Kubernetes YAML files *and* apply them to your cluster.  If you omit the `-e` option, the 
+You need to provide the WebLogic administration user name and password in the `-u` and `-p` options
+respectively, as shown in the example.  If you specify the `-e` option, the script will generate the
+Kubernetes YAML files *and* apply them to your cluster.  If you omit the `-e` option, the
 script will just generate the YAML files, but will not take any action on your cluster.
 
 c.	Confirm that the operator started the servers for the domain:
@@ -201,9 +201,9 @@ $ helm install kubernetes/samples/charts/ingress-per-domain \
   --set traefik.hostname=sample-domain1.org
 ```
 
-e.	To confirm that the load balancer noticed the new Ingress and is successfully routing to the domain's server pods
-    you can hit the URL for the "WebLogic Ready App" which will return a HTTP 200 status code as
-    shown in the example below.  If you used the host-based routing ingress sample you will need to
+e.	To confirm that the load balancer noticed the new Ingress and is successfully routing to the domain's server pods,
+    you can hit the URL for the "WebLogic Ready App" which will return a HTTP 200 status code, as
+    shown in the example below.  If you used the host-based routing Ingress sample, you will need to
     provide the hostname in the `-H` option:
 ```
 $ curl -v -H 'host: sample-domain1.org' http://your.server.com:30305/weblogic/

@@ -234,7 +234,7 @@ b.	Remove the domain resources by using the sample [`delete-weblogic-domain-reso
 ```
 $ kubernetes/samples/scripts/delete-domain/delete-weblogic-domain-resources.sh -d sample-domain1
 ```
-c.	Use `kubectl` to confirm that the server pods and domain resource are gone.
+c.	Use `kubectl` to confirm that the server pods and domain resource are gone:
 ```
 $ kubectl get pods -n sample-domain1-ns
 $ kubectl get domains -n sample-domain1-ns
@@ -252,7 +252,7 @@ $ helm upgrade \
   stable/traefik
 ```
 
-b.	Configure the operator to stop managing the domain.
+b.	Configure the operator to stop managing the domain:
 
 ```
 $ helm upgrade \

site/user-guide.md

@@ -1,6 +1,6 @@
 # User guide
 
-This document provides detailed information targeted to users of the Oracle WebLogic
+This document provides detailed user information for the Oracle WebLogic
 Server Kubernetes Operator.  It provides instructions on how to install the operator in your
 Kubernetes cluster and how to use it to manage WebLogic domains.  
 
@@ -18,9 +18,9 @@ presented in the correct order.
 * [Getting started](#getting-started)
 * [Prerequisites](#prerequisites)
 * [Preparing your Kubernetes environment to run the operator](prepare-k8s.md)
-  * [Set up your Kubernetes cluster](prepare-k8s.md#set-up-your-kubernetes-cluster)
-  * [Set up load balancers](prepare-k8s.md#load-balancing-with-an-ingress-controller-or-a-web-server)
-  * [Configuring Kibana and Elasticsearch](prepare-k8s.md#configuring-kibana-and-elasticsearch)
+  * [Set up your Kubernetes cluster](k8s_setup.md)
+  * [Set up load balancers](../kubernetes/samples/charts/README.md)
+  * [Configuring Kibana and Elasticsearch](../kubernetes/samples/scripts/elasticsearch-and-kibana/README.md)
 * [Install and manage the operator](install.md)
   * [Using the Helm charts](helm-charts.md)
 * [Using the operator's REST interface](rest.md)