review and edit (#2114)

Author: rosemarymarano

docs-source/content/faq/resource-settings.md

@@ -166,7 +166,7 @@ Note that some Kubernetes environments may not allow changing the CPU management
 #### Measuring JVM heap, Pod CPU, and Pod memory
 You can monitor JVM heap, Pod CPU, and Pod memory using Prometheus and Grafana. Also, see [Tools for Monitoring Resources](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/) in the Kubernetes documentation.
 
-#### References:
+#### References
 1. [Managing Resources for Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) in the Kubernetes documentation.
 1. [Assign Memory Resources to Containers and Pods](https://kubernetes.io/docs/tasks/configure-pod-container/assign-memory-resource) in the Kubernetes documentation.
 1. [Assign CPU Resources to Containers and Pods](https://kubernetes.io/docs/tasks/configure-pod-container/assign-cpu-resource/) in the Kubernetes documentation.

docs-source/content/quickstart/install.md

@@ -22,14 +22,14 @@ Create a namespace for the ingress controller.
 $ kubectl create namespace traefik
 ```
 
-Use the [values.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/values.yaml) in the sample but set `kubernetes.namespaces` specifically.
+Use the [values.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/values.yaml) file in the sample but set `kubernetes.namespaces` specifically.
 
 
 ```bash
 $ helm install traefik-operator traefik/traefik \
     --namespace traefik \
     --values kubernetes/samples/charts/traefik/values.yaml \
-    --set "kubernetes.namespaces={traefik}" 
+    --set "kubernetes.namespaces={traefik}"
 ```
 
 #### Install the operator.
@@ -58,9 +58,9 @@ $ helm install traefik-operator traefik/traefik \
       --set "domainNamespaceLabelSelector=weblogic-operator\=enabled" \
       --wait
     ```
-    
+
     This Helm release deploys the operator and configures it to manage Domains in any Kubernetes namespace with the label, "weblogic-operator=enabled". Because of the "enableClusterRoleBinding" option, the operator will have privilege in all Kubernetes namespaces. This simplifies adding and removing managed namespaces as you will only have to adjust labels on those namespaces. If you want to limit the operator's privilege to just the set of namespaces that it will manage, then remove this option, but this will mean that the operator only has privilege in the set of namespaces that match the selection strategy at the time the Helm release was installed or upgraded.
-    
+
     **Note:** Prior to version 3.1.0, the operator's Helm chart only supported configuring the namespaces that the operator would manage using a list of namespaces. The chart now supports specifying namespaces using a label selector, regular expression, or list. Review the available [Helm configuration values]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#operator-helm-configuration-values" >}}).
 
 4. Verify that the operator's pod is running, by listing the pods in the operator's namespace. You should see one

docs-source/content/samples/simple/azure-kubernetes-service/_index.md

@@ -24,7 +24,7 @@ AKS is a managed Kubernetes Service that lets you quickly deploy and manage Kube
 
 #### Prerequisites
 
-This sample assumes the following prerequisite environment setup.
+This sample assumes the following prerequisite environment setup:
 
 * Operating System: GNU/Linux, macOS or [WSL for Windows 10](https://docs.microsoft.com/windows/wsl/install-win10).
 * [Git](https://git-scm.com/downloads), use `git --version` to test if `git` works.  This document was tested with version 2.17.1.
@@ -66,7 +66,7 @@ Found an existing application instance of "5pn2s201-nq4q-43n1-z942-p9r9571qr3rp"
 Insufficient privileges to complete the operation.
 ```
 
-The problem may be a pre-existing service principal with the same name.  Either delete the other Service Principal or pick a different name.
+The problem may be a pre-existing service principal with the same name.  Either delete the other service principal or pick a different name.
 
 Successful output will look like the following:
 
@@ -846,11 +846,11 @@ Now that you have WLS running in AKS, you can test the cluster by deploying the
 
 Next you will need to start the application:
 
-1. Go to Deployments
-1. Select Control
-1. Select testwebapp
-1. Select Start
-1. Select Servicing all requests
+1. Go to Deployments.
+1. Select Control.
+1. Select `testwebapp`.
+1. Select Start.
+1. Select Servicing all requests.
 1. Select Yes.
 
 After the successful deployment, go to the application through the domain1-cluster-1-lb external IP.
@@ -867,16 +867,17 @@ The test application will list the server host and server IP on the page.
 
 #### Access WebLogic Server logs
 
-The logs are stored in the Azure file share. Follow these steps to access the log:
+The logs are stored in the Azure file share. Follow these steps to access the logs:
 
 1. Go to the [Azure Portal](https://ms.portal.azure.com).
 1. Go to your resource group.
 1. Open the storage account.
 1. In the "File service" section of the left panel, select File shares.
-1. Select the file share name (e.g. weblogic in this example).
+1. Select the file share name (for example, `weblogic` in this example).
 1. Select logs.
 1. Select domain1.
-1. WebLogic Server logs are listed in the folder.
+
+   WebLogic Server logs are listed in the folder.
 
    ![WebLogic Server Logs](screenshot-logs.png)
 
@@ -996,9 +997,9 @@ The logs are stored in the Azure file share. Follow these steps to access the lo
 
    Some suggestions for debugging problems with Model in Image after your Domain YAML file is deployed are found in the section on [debugging](/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/debugging/).
 
-#### Clean Up Resources
+#### Clean up resources
 
-The output from the `create-domain-on-aks.sh` script includes a statement about the Azure resources created by the script.  To delete the cluster and free all related resources, simply delete the resource groups.  The output will list the resource groups, such as.
+The output from the `create-domain-on-aks.sh` script includes a statement about the Azure resources created by the script.  To delete the cluster and free all the related resources, simply delete the resource groups.  The output will list the resource groups, such as:
 
 ```bash
 The following Azure Resouces have been created:

docs-source/content/samples/simple/domains/manually-create-domain/_index.md

@@ -10,7 +10,7 @@ In some circumstances you may wish to manually create your domain custom resourc
 Docker image containing your domain and the specific patches that it requires, then this approach will probably
 be the most suitable for your needs.
 
-To create the domain custom resource, just make a copy of the sample [domain.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/domain.yaml), and then edit
+To create the domain custom resource, just make a copy of the sample [domain.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/domain.yaml) file, and then edit
 it using the instructions provided in the comments in that file.
 When it is ready, you can create the domain in your Kubernetes cluster using the command:
 

docs-source/content/samples/simple/tanzu-kubernetes-service/_index.md

@@ -23,7 +23,7 @@ TKG is a managed Kubernetes Service that lets you quickly deploy and manage Kube
 
 #### Prerequisites
 
-This sample assumes the following prerequisite environment setup.
+This sample assumes the following prerequisite environment setup:
 
 * WebLogic Server Kubernetes Operator: This document was tested with version v3.1.0.
 * Operating System: GNU/Linux.

docs-source/content/userguide/cicd/how-to-copy-domains.md

@@ -6,7 +6,7 @@ weight: 5
 description: "How to copy domains."
 ---
 
-The recommended approach to save a copy of a Domain in Image or Domain in PV 
+The recommended approach to save a copy of a Domain in Image or Domain in PV
 domain is to simply ZIP (or tar)
 the domain directory.  However, there is a very important caveat with this
 recommendation - when you unzip the domain, it must go back into exactly
@@ -17,7 +17,7 @@ The best practice/recommended approach is to create a "primordial domain"
 which does not contain any applications or resources,
 and to create a ZIP file of this domain before starting any servers.  
 
-> **The domain ZIP must be created before starting servers.**  
+> **The domain ZIP file must be created before starting servers.**  
 
 When servers are started the first time, they will encrypt various other data.
 Make sure that you create the ZIP file before starting servers for the first time.

docs-source/content/userguide/cicd/tools.md

@@ -30,7 +30,7 @@ that you supply a domain home.
 Other than the tools themselves, there are three components to the WDT tools:  
 
 - *The Domain Model* - Metadata model describing the desired domain.  
-  The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling#the-metadata-model).
+  The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md).
 - *The Archive ZIP* - Binaries to supplement the model.  
   All binaries needed to supplement the model must be specified in an archive
   file, which is just a ZIP file with a specific directory structure. Optionally,

docs-source/content/userguide/introduction/architecture.md

@@ -78,7 +78,7 @@ It is worth providing some background information on why this approach was adopt
 
 The external state approach allows the operator to treat the Docker images as essentially immutable, read-only, binary images.  This means that the image needs to be pulled only once, and that many domains can share the same image.  This helps to minimize the amount of bandwidth and storage needed for WebLogic Server Docker images.
 
-This approach also eliminates the need to manage any state created in a running container, because all of the state that needs to be preserved is written into either the persistent volume or a database back end. The containers and pods are completely throwaway and can be replaced with new containers and pods, as necessary.  This makes handling failures and rolling restarts much simpler because there is no need to preserve any state inside a running container.
+This approach also eliminates the need to manage any state created in a running container, because all of the state that needs to be preserved is written into either the persistent volume or a database backend. The containers and pods are completely throwaway and can be replaced with new containers and pods, as necessary.  This makes handling failures and rolling restarts much simpler because there is no need to preserve any state inside a running container.
 
 When users wish to apply a binary patch to WebLogic Server, it is necessary to create only a single new, patched Docker image.  If desired, any domains that are running may be updated to this new patched image with a rolling restart, because there is no state in the containers.
 

docs-source/content/userguide/managing-domains/_index.md

@@ -88,20 +88,20 @@ The following features are **not** certified or supported in this release:
 For up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments, see My Oracle Support Doc ID 2349228.1.
 
 ### Meet Kubernetes resource name restrictions
-          
+
 Kubernetes requires that the names of some resource types follow the DNS label standard as defined in [DNS Label Names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names) and [RFC 1123](https://tools.ietf.org/html/rfc1123). This requirement restricts the characters that are allowed in the names of these resources, and also limits the length of these names to no more than 63 characters.
 
 The following is a list of such Kubernetes resources that the operator generates when a domain resource is deployed, including how their names are constructed.
-          
+
 * A domain introspector job named `<domainUID>-<introspectorJobNameSuffix>`. The default suffix is `-introspector`, which can be overridden using the operator's Helm configuration `introspectorJobNameSuffix` (see [WebLogic domain management]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#weblogic-domain-management" >}})).
 * A ClusterIP type service and a pod for each WebLogic Server named `<domainUID>-<serverName>`.
 * A ClusterIP type service for each WebLogic cluster named `<domainUID>-cluster-<clusterName>`.
 * An optional NodePort type service, also known as an external service, for the WebLogic Administration Server named `<domainUID>-<adminServerName>-<externalServiceNameSuffix>`. The default suffix is `-ext`, which can be overridden using the operator's Helm configuration `externalServiceNameSuffix` (see [WebLogic domain management]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#weblogic-domain-management" >}})).
 
 The operator puts in place certain validation checks and conversions to prevent these resources from violating Kubernetes restrictions.
 * All the names previously described can contain only the characters `A-Z`, `a-z`, `0-9`, `-`, or `_`, and must start and end with an alphanumeric character. Note that when generating pod and service names, the operator will convert configured names to lower case and substitute a hyphen (`-`) for each underscore (`_`).
-* A `domainUID` is required to be no more than 45 characters. 
-* WebLogic domain configuration names, such as the cluster names, Administration Server name, and Managed Server names must be kept to a legal length so that the resultant resource names do not exceed Kubernetes' limits. 
+* A `domainUID` is required to be no more than 45 characters.
+* WebLogic domain configuration names, such as the cluster names, Administration Server name, and Managed Server names must be kept to a legal length so that the resultant resource names do not exceed Kubernetes' limits.
 
 When a domain resource or WebLogic domain configuration violates the limits, the domain startup will fail, and actual validation errors are reported in the domain resource's status.
 
@@ -148,7 +148,7 @@ See [Starting and stopping]({{< relref "/userguide/managing-domains/domain-lifec
 
 The operator let's you initiate scaling of clusters in various ways:
 
-* [Using kubectl to edit the Domain resource]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#on-demand-updating-the-domain-resource-directly" >}})
+* [Using kubectl to edit the Domain resource]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#on-demand-updating-the-domain-directly" >}})
 * [Using the operator's REST APIs]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#calling-the-operators-rest-scale-api" >}})
 * [Using WLDF policies]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#using-a-wldf-policy-rule-and-script-action-to-call-the-operators-rest-scale-api" >}})
 * [Using a Prometheus action]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#using-a-prometheus-alert-action-to-call-the-operators-rest-scale-api" >}})

docs-source/content/userguide/managing-domains/configoverrides/_index.md

@@ -3,7 +3,7 @@ title = "Configuration overrides"
 date = 2019-02-23T16:45:16-05:00
 weight = 5
 pre = "<b> </b>"
-+++ 
++++
 
 #### Contents
 
@@ -208,7 +208,9 @@ Two types of macros are supported, environment variable macros and secret macros
 
 The secret macro `SECRETNAME` field must reference the name of a Kubernetes Secret, and the `SECRETKEY` field must reference a key within that Secret. For example, if you have created a Secret named `dbuser` with a key named `username` that contains the value `scott`, then the macro `${secret:dbuser.username}` will be replaced with the word `scott` before the template is copied into its WebLogic Server instance Pod.
 
-**SECURITY NOTE: Use the `:encrypt` suffix in a secret macro to encrypt its replacement value with the WebLogic WLST `encrypt` command (instead of leaving it at its plain text value).  This is useful for overriding MBean attributes that expect encrypted values, such as the `password-encrypted` field of a data source, and is also useful for ensuring that a custom overrides configuration file the operator places in the domain home does not expose passwords in plain-text.**
+{{% notice warning %}}
+**SECURITY NOTE**: Use the `:encrypt` suffix in a secret macro to encrypt its replacement value with the WebLogic WLST `encrypt` command (instead of leaving it at its plain text value).  This is useful for overriding MBean attributes that expect encrypted values, such as the `password-encrypted` field of a data source, and is also useful for ensuring that a custom overrides configuration file the operator places in the domain home does not expose passwords in plain-text.
+{{% /notice %}}
 
 #### Override template syntax special requirements
 
@@ -469,5 +471,5 @@ when `spec.logHome` is configured and `spec.logHomeEnabled` is true.
   * WebLogic Server instances monitor the files in `optconfig` and dynamically update the active configuration based on the current contents of the configuration overrides files.
   * Otherwise, if the `overridesDistributionStrategy` is ON_RESTART, then the updated files at the ConfigMap's mount point are not copied to `optconfig` while the WebLogic Server instance is running and, therefore, don't affect the active configuration.
 
-{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source "passwordEncrypted" attribute is dynamic while the "Url" attribute is non-dynamic.
+{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source `passwordEncrypted` attribute is dynamic while the `Url` attribute is non-dynamic.
 {{% /notice %}}