Skip to content

Commit a300d1f

Browse files
authored
Merge pull request #973 from oracle/promote-new-docs
Promote new docs
2 parents fa23222 + 178f7be commit a300d1f

24 files changed

+18
-67
lines changed

README.md

Lines changed: 7 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -31,84 +31,33 @@ This release was published on March 4, 2019.
3131
| --- | --- |
3232
| | |
3333

34-
## Operator version 2.0
34+
# Documentation
3535

36-
Documentation for the 2.0 release of the operator is available [here](site/v2.0/README.md).
36+
Documentation for the operator is available [here](https://oracle.github.io/weblogic-kubernetes-operator) and includes
37+
information for users and for developers. It provides samples, reference material like API documentation, security
38+
information and a *Quick Start* guide if you just want to get up and running quickly.
3739

38-
## Operator version 1.1
40+
## Documentation for old releases
3941

40-
Documentation for the 1.1 release of the operator is available [here](site/v1.1/README.md).
42+
Documentation for old releases of the operator is available [here](site/README.md).
4143

4244
# Backward compatibility guidelines
4345

44-
The 2.0 release introduces some breaking changes and does not maintain compatibility with previous releases.
46+
The 2.0 release introduced some breaking changes and did not maintain compatibility with previous releases.
4547

4648
Starting with the 2.0 release, future operator releases are intended to be backward compatible with respect to the domain
4749
resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created
4850
by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to
4951
maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be
5052
maintained for one release after a replacement is available.
5153

52-
# About this documentation
53-
54-
This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily,
55-
please consult this table of contents:
56-
57-
* The [Quick Start guide](site/quickstart.md) explains how to quickly get the operator running, using the defaults, nothing special.
58-
* The [User guide](site/user-guide.md) contains detailed usage information, including how to install and configure the operator,
59-
and how to use it to create and manage WebLogic domains.
60-
* The [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
61-
various tasks related to the operator.
62-
* 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
63-
API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs.
64-
* The [Contributing](#contributing-to-the-operator) section provides information about contribution requirements.
65-
66-
67-
# User guide
68-
69-
The [User guide](site/user-guide.md) provides detailed information about all aspects of using the operator including:
70-
71-
* Installing and configuring the operator.
72-
* Using the operator to create and manage WebLogic domains.
73-
* Manually creating WebLogic domains to be managed by the operator.
74-
* Scaling WebLogic clusters.
75-
* Configuring Kubernetes load balancers.
76-
* Configuring Elasticsearch and Kibana to access the operator's log files.
77-
* Shutting down domains.
78-
* Removing/deleting domains.
79-
* And much more!
80-
81-
# Samples
82-
83-
Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code.
84-
8554
# Need more help? Have a suggestion? Come and say, "Hello!"
8655

8756
We have a **public Slack channel** where you can get in touch with us to ask questions about using the operator or give us feedback
8857
or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel,
8958
please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include
9059
details of how to access our Slack workspace. After you are logged in, please come to `#operator` and say, "hello!"
9160

92-
# Recent changes
93-
94-
See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
95-
96-
# Developer guide
97-
98-
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.
99-
100-
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!
101-
102-
## API documentation
103-
104-
Documentation for APIs:
105-
106-
* 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).
107-
108-
* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface.
109-
110-
* See the [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
111-
11261
# Contributing to the operator
11362

11463
Oracle welcomes contributions to this project from anyone. Contributions may be reporting an issue with the operator or submitting a pull request. Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first.

site/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Oracle WebLogic Server Kubernetes Operator documentation
22

3-
This directory contains the documentation for the current version of the operator, version 2.0.
3+
Documentation for the current version of the operator, version 2.0.1, is
4+
available [here](https://oracle.github.io/weblogic-kubernetes-operator).
45

56
If you wish to view documentation for an older version, please see:
67

78
* [Version 1.0](v1.0)
89
* [Version 1.1](v1.1)
910
* [Version 2.0](v2.0)
11+
* [Version 2.0.1](v2.0.1)
1012

1113
For a guide to the operator project, refer to this [README](../README.md).

site/architecture.md renamed to site/v2.0.1/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The operator registers a Kubernetes custom resource definition called `domain.we
2121

2222
The diagram below shows the general layout of high-level components, including optional components, in a Kubernetes cluster that is hosting WebLogic domains and the operator:
2323

24-
![High level architecture](images/high-level-architecture.png)
24+
![High level architecture](../images/high-level-architecture.png)
2525

2626
The Kubernetes cluster has several namespaces. Components may be deployed into namespaces as follows:
2727

@@ -34,7 +34,7 @@ The Kubernetes cluster has several namespaces. Components may be deployed into
3434

3535
The diagram below shows how the various parts of a WebLogic domain are manifest in Kubernetes by the operator.
3636

37-
![Domain architecture](images/domain-architecture2.png)
37+
![Domain architecture](../images/domain-architecture2.png)
3838

3939
This diagram shows the following details:
4040

@@ -48,7 +48,7 @@ This diagram shows the following details:
4848

4949
The diagram below shows the components inside the containers running WebLogic Server instances:
5050

51-
![Inside a container](images/inside-a-container.png)
51+
![Inside a container](../images/inside-a-container.png)
5252

5353
The domain resource specifies a Docker image, defaulting to `store/oracle/weblogic:12.2.1.3`. All containers running WebLogic Server use this same Docker image. Depending on the use case, this image could contain the WebLogic Server product binaries or also include the domain directory.
5454
**Note**: During a rolling event caused by a change to the domain resource's `image` field, containers will be using a mix of the updated value of the `image` field and its previous value.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)