Skip to content

Commit 212e668

Browse files
committed
Synchronize documentation
1 parent f51c20d commit 212e668

File tree

100 files changed

+4349
-1822
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+4349
-1822
lines changed

documentation/3.4/content/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ You can:
1010
* Deploy an operator that manages all WebLogic domains in all namespaces in a Kubernetes cluster, or that only manages domains in a specific subset of the namespaces, or that manages only domains that are located in the same namespace as the operator. At most, a namespace can be managed by one operator.
1111
* Supply WebLogic domain configuration using:
1212
* _Domain in PV_: Locates WebLogic domain homes in a Kubernetes PersistentVolume (PV). This PV can reside in an NFS file system or other Kubernetes volume types.
13-
* _Domain in Image_: Includes a WebLogic domain home in a container image.
14-
* _Model in Image_: Includes [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) models and archives in a container image.
13+
* _Domain in Image_: Includes a WebLogic domain home in an image.
14+
* _Model in Image_: Includes [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) models and archives in an image.
1515
* Configure deployment of WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition).
1616
* Override certain aspects of the WebLogic domain configuration; for example, use a different database password for different deployments.
1717
* Start and stop servers and clusters in the domain based on declarative startup parameters and desired states.
@@ -31,7 +31,7 @@ using the operator to deploy and run a WebLogic domain container-packaged web ap
3131
#### Current production release
3232

3333
The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is {{< latestVersion >}}.
34-
This release was published on February 18, 2022. See the [operator prerequisites]({{< relref "/userguide/prerequisites/introduction.md" >}}) and [supported environments]({{< relref "/userguide/platforms/environments.md" >}}).
34+
This release was published on April 21, 2022. See the [operator prerequisites]({{< relref "/userguide/prerequisites/introduction.md" >}}) and [supported environments]({{< relref "/userguide/platforms/environments.md" >}}).
3535

3636
***
3737

documentation/3.4/content/developerguide/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
title = "Developer Guide"
33
date = 2019-02-22T15:27:54-05:00
44
weight = 7
5-
chapter = true
65
pre = "<b> </b>"
76
+++
87

9-
10-
# Developer Guide
11-
128
The Developer Guide provides information for developers who want to understand or contribute to the code.
9+
10+
{{% children style="h4" description="true" %}}

documentation/3.4/content/developerguide/asynchronous-call-model.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Asynchronous call model"
33
date: 2019-02-23T17:20:00-05:00
44
draft: false
5+
description: "The operator employs an efficient, user-level threads pattern to implement an asynchronous call model for Kubernetes API requests."
56
weight: 7
67
---
78

documentation/3.4/content/developerguide/backwards-compatibility.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Backward compatibility"
33
date: 2019-02-23T17:26:09-05:00
44
draft: false
5+
description: "Review the operator's backward compatibility and maintenance."
56
weight: 9
67
---
78

documentation/3.4/content/developerguide/branching.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Branching"
33
date: 2019-02-23T17:19:29-05:00
44
draft: false
5+
description: "Understand the operator repository branching strategy."
56
weight: 4
67
---
78

@@ -11,6 +12,6 @@ Because we want to balance separating destabilizing work into feature branches a
1112

1213
All commits to `main` must pass the [integration test suite]({{< relref "/developerguide/integration-tests.md" >}}). Please run these tests locally before submitting a pull request. Additionally, each push to a branch in our GitHub repository triggers a run of a subset of the integration tests with the results visible [here](http://build.weblogick8s.org:8080/job/weblogic-kubernetes-operator-quicktest/).
1314

14-
Please submit pull requests to the `main` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests in [Contribute to the operator]({{< relref "/developerguide/contributing#contributing-to-the-oracle-weblogic-server-kubernetes-operator-repository" >}}).
15+
Please submit pull requests to the `main` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests in [Contribute to the operator]({{< relref "/developerguide/contributing#contributing-to-the-weblogic-kubernetes-operator-repository" >}}).
1516

1617
We will create git tags for each release candidate and generally available (GA) release of the operator.

documentation/3.4/content/developerguide/building.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Building"
33
date: 2019-02-23T17:19:24-05:00
44
draft: false
5+
description: "Learn about the operator build process."
56
weight: 3
67
---
78

@@ -32,7 +33,7 @@ We recommend that you use a tag other than `latest`, to make it easy to distingu
3233

3334
#### Running the operator from an IDE
3435

35-
The operator can be run from an IDE, which is useful for debugging. In order to do so, the machine running the IDE must be configured with a Kubernetes configuration file in `~/.kube/config` or in a location pointed to by the `KUBECONFIG` environment variable.
36+
The operator can be run from an IDE, which is useful for debugging. To do so, the machine running the IDE must be configured with a Kubernetes configuration file in `~/.kube/config` or in a location pointed to by the `KUBECONFIG` environment variable.
3637

3738
Configure the IDE to run the class `oracle.kubernetes.operator.Main`.
3839

documentation/3.4/content/developerguide/code-structure.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Code structure"
33
date: 2019-02-23T17:25:04-05:00
44
draft: false
5+
description: "Review the project directory structure."
56
weight: 6
67
---
78

@@ -11,7 +12,7 @@ This project has the following directory structure:
1112
* `documentation/<numbered directory>`: The archived documentation for a previous release
1213
* `documentation/charts`: Helm chart repository
1314
* `documentation/swagger`: The operator REST API swagger
14-
* `documentation/domains`: Reference for Domain resource schema
15+
* `documentation/domains`: Reference for Domain resource schema
1516
* `json-schema-generator`: Java model to JSON schema generator
1617
* `json-schema-maven-plugin`: Maven plugin for schema generator
1718
* `kubernetes/charts`: Helm charts

documentation/3.4/content/developerguide/coding-standards.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
title: "Coding standards"
33
date: 2019-02-23T17:24:10-05:00
44
draft: false
5+
description: "Review the project coding standards."
56
weight: 5
67
---
78

89

910
This project has adopted the following coding standards:
1011

11-
* Code will be formated using Oracle / WebLogic standards, which are identical to the [Google Java Style](https://google.github.io/styleguide/javaguide.html).
12+
* Code should be formatted using Oracle / WebLogic standards, which are identical to the [Google Java Style](https://google.github.io/styleguide/javaguide.html).
1213
* Javadoc must be provided for all public packages, classes, and methods, and must include all parameters and returns. Javadoc is not required for methods that override or implement methods that are already documented.
1314
* All non-trivial methods should include `LOGGER.entering()` and `LOGGER.exiting()` calls.
1415
* The `LOGGER.exiting()` call should include the value that is going to be returned from the method, unless that value includes a credential or other sensitive information.

documentation/3.4/content/developerguide/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Contribute to the operator"
33
date: 2019-02-23T17:19:19-05:00
44
draft: false
5+
description: "Learn how to contribute to the operator project."
56
weight: 1
67
---
78

documentation/3.4/content/developerguide/documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Documentation"
33
date: 2019-03-19T07:13:22-04:00
44
draft: false
5+
description: "Learn how to contribute to the operator documentation."
56
weight: 9
67
---
78

0 commit comments

Comments
 (0)