Skip to content

Commit aad2a1c

Browse files
minor edits, fix broken link
1 parent 416f623 commit aad2a1c

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ maintained for one release after a replacement is available.
5252

5353
# About this documentation
5454

55-
This documentation includes sections aimed at different audiences. To help you find what you are looking for more easily,
55+
This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily,
5656
please consult this table of contents:
5757

58-
* The [Quick start guide](site/quickstart.md) explains how to just get the operator running quickly, using all the defaults, nothing special.
59-
* The [User guide](site/user-guide.md) contains detailed information for users of the operator, including how to install and configure it,
58+
* The [Quick start guide](site/quickstart.md) explains how to quickly get the operator running, using the defaults, nothing special.
59+
* The [User guide](site/user-guide.md) contains detailed usage information, including how to install and configure the operator,
6060
and how to use it to create and manage WebLogic domains.
61-
* Our [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
61+
* The [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
6262
various tasks related to the operator.
6363
* 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
6464
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
8181

8282
# Samples
8383

84-
Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code we provide.
84+
Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code.
8585

8686
# Need more help? Have a suggestion? Come and say "Hello!"
8787

@@ -98,17 +98,17 @@ See [Recent changes](site/recent-changes.md) for changes to the operator, includ
9898

9999
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.
100100

101-
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!
101+
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!
102102

103103
## API documentation
104104

105105
Documentation for APIs is provided here:
106106

107-
* 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).
107+
* 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).
108108

109109
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
110110

111-
* [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
111+
* See the [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
112112

113113
# Contributing to the operator
114114

site/database.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11

22
# Running the Oracle Database in Kubernetes
33

4-
If you wish to run the Oracle Database inside your Kubernetes cluster, in order to place
5-
your state store, leasing tables, etc., in that database, then you can use this
6-
sample to install the database.
4+
If you wish to run the Oracle Database inside your Kubernetes cluster, in order to place
5+
your state store, leasing tables, and such, in that database, then you can use this
6+
sample to install the database.
77

88
You must configure your database to store its DB files
9-
on persistent storage. Refer to your cloud vendor's documentation for details of
9+
on persistent storage. Refer to your cloud vendor's documentation for details of
1010
available storage providers and how to create a persistent volume and attach it to a pod.
1111

12-
First create a namespace for the database:
12+
First create a namespace for the database:
1313

14-
```
14+
```
1515
kubectl create namespace database-namespace
1616
```
1717

1818
Next, create a file called `database.yml` with the following content. Make sure you update the
19-
password field with you chosen administrator password for the database.
19+
password field with your chosen administrator password for the database.
2020

2121
```
2222
apiVersion: extensions/v1beta1
@@ -97,7 +97,7 @@ and accept the license for the [Oracle database image](https://container-registr
9797

9898
Create a Docker registry secret so that Kubernetes can pull the database image:
9999

100-
```
100+
```
101101
kubectl create secret docker-registry regsecret \
102102
--docker-server=container-registry.oracle.com \
103103
@@ -109,12 +109,12 @@ kubectl create secret docker-registry regsecret \
109109

110110
Now use the following command to install the database:
111111

112-
```
112+
```
113113
kubectl apply -f database.yml
114114
```
115115

116116
This will start up the database and expose it in the cluster at the following address:
117117

118-
```
118+
```
119119
database.database-namespace.svc.cluster.local:1521
120-
```
120+
```

site/prepare-k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Set up your Kubernetes cluster
66

7-
If you need help setting up a Kubernetes environment, check our [cheat sheet](site/k8s_setup.md).
7+
If you need help setting up a Kubernetes environment, check our [cheat sheet](k8s_setup.md).
88

99
After creating Kubernetes clusters, you can optionally:
1010
* Create load balancers to direct traffic to backend domains.

site/user-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# User guide
22

3-
This document provides detailed information targeted to users of the Oracle WebLogic
3+
This document provides detailed user information for the Oracle WebLogic
44
Server Kubernetes Operator. It provides instructions on how to install the operator in your
55
Kubernetes cluster and how to use it to manage WebLogic domains.
66

@@ -18,9 +18,9 @@ presented in the correct order.
1818
* [Getting started](#getting-started)
1919
* [Prerequisites](#prerequisites)
2020
* [Preparing your Kubernetes environment to run the operator](prepare-k8s.md)
21-
* [Set up your Kubernetes cluster](prepare-k8s.md#set-up-your-kubernetes-cluster)
22-
* [Set up load balancers](prepare-k8s.md#load-balancing-with-an-ingress-controller-or-a-web-server)
23-
* [Configuring Kibana and Elasticsearch](prepare-k8s.md#configuring-kibana-and-elasticsearch)
21+
* [Set up your Kubernetes cluster](k8s_setup.md)
22+
* [Set up load balancers](../kubernetes/samples/charts/README.md)
23+
* [Configuring Kibana and Elasticsearch](../kubernetes/samples/scripts/elasticsearch-and-kibana/README.md)
2424
* [Install and manage the operator](install.md)
2525
* [Using the Helm charts](helm-charts.md)
2626
* [Using the operator's REST interface](rest.md)

0 commit comments

Comments
 (0)