diff --git a/site/developer.md b/site/developer.md index fa24014379e..af9c971969f 100644 --- a/site/developer.md +++ b/site/developer.md @@ -6,18 +6,18 @@ This page provides information for developers who wish to understand or contribu The following software are required to obtain and build the operator: -* git (1.8 or later recommended) +* Git (1.8 or later recommended) * Apache Maven (3.3 or later recommended) * Java Developer Kit (1.8u131 or later recommended, not 1.9) * Docker 17.03.1.ce The operator is written primarily in Java and BASH shell scripts. The Java code uses features introduced in Java 1.8, for example closures, but does not use any Java 1.9 feature. -Since the target runtime environment for operator is Oracle Linux, no particular effort has been made to ensure the build or tests run on any other operating system. Please be aware that Oracle will not provide support for, or accept pull requests to add support for other operating systems. +Because the target runtime environment for the operator is Oracle Linux, no particular effort has been made to ensure the build or tests run on any other operating system. Please be aware that Oracle will not provide support, or accept pull requests to add support, for other operating systems. ## Obtaining the operator source code -The operator source code is published on GitHub at https://github.com/oracle/weblogic-operator. Developers may clone this repository to a local machine, or if desired create a fork in their personal namespace and clone the fork. Developers who are planning to submit a pull request are advised to create a fork. +The operator source code is published on GitHub at https://github.com/oracle/weblogic-operator. Developers may clone this repository to a local machine or, if desired, create a fork in their personal namespace and clone the fork. Developers who are planning to submit a pull request are advised to create a fork. To clone the repository from GitHub, issue this command: @@ -29,13 +29,13 @@ git clone https://github.com/oracle/weblogic-operator The operator is built using [Apache Maven](http://maven.apache.org). The build machine will also need to have Docker installed. -To build the operator issue the following command in the project directory: +To build the operator, issue the following command in the project directory: ``` mvn clean install ``` -This will compile the source files, build JAR files containing the compiled classes and libraries needed to run the Operator and will also execute all of the unit tests. +This will compile the source files, build JAR files containing the compiled classes and libraries needed to run the operator, and will also execute all of the unit tests. ## Building Javadoc @@ -49,9 +49,9 @@ The Javadoc is also available in the GitHub repository at [https://oracle.github ## Running integration tests -The project includes integration tests that can be run against a Kubernetes *cluster*. If you want to use these tests, you will need to provide your own Kubernetes *cluster*. You will need to obtain the kube.config file for an admin user and make it available on the machine running the build. Tests will run against Kubernetes 1.7.x and 1.8.x currently. There are some issues with 1.9, which are being worked on. +The project includes integration tests that can be run against a Kubernetes *cluster*. If you want to use these tests, you will need to provide your own Kubernetes *cluster*. You will need to obtain the `kube.config` file for an administrator user and make it available on the machine running the build. Tests will run against Kubernetes 1.7.x and 1.8.x currently. There are some issues with 1.9, which are being worked on. -To run the tests, uncomment the following `execution` in the `pom.xml` and update the `KUBECONFIG` to point to your kube config file. +To run the tests, uncomment the following `execution` element in the `pom.xml` file and update the `KUBECONFIG` to point to your kube config file. ```