Skip to content

Commit 2515fb0

Browse files
committed
Synchronize documentation
1 parent f982625 commit 2515fb0

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The [current release of the operator](https://github.com/oracle/weblogic-kuberne
2929
This release was published on November 1, 2021.
3030
***
3131

32-
# Documentation
32+
## Documentation
3333

3434
Documentation for the operator is [available here](https://oracle.github.io/weblogic-kubernetes-operator).
3535

@@ -38,7 +38,7 @@ information and a [Quick Start](https://oracle.github.io/weblogic-kubernetes-ope
3838

3939
Documentation for prior releases of the operator: [2.5.0](https://oracle.github.io/weblogic-kubernetes-operator/2.5/), [2.6.0](https://oracle.github.io/weblogic-kubernetes-operator/2.6/), [3.0.x](https://oracle.github.io/weblogic-kubernetes-operator/3.0/), [3.1.x](https://oracle.github.io/weblogic-kubernetes-operator/3.1/), and [3.2.x](https://oracle.github.io/weblogic-kubernetes-operator/3.2/).
4040

41-
# Backward compatibility guidelines
41+
## Backward compatibility guidelines
4242

4343
The 2.0 release introduced some breaking changes and did not maintain compatibility with previous releases.
4444

@@ -48,26 +48,24 @@ by the operator Helm chart, Kubernetes resources created by the operator, and th
4848
maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be
4949
maintained for one release after a replacement is available.
5050

51-
# Need more help? Have a suggestion? Come and say, "Hello!"
51+
## Need more help? Have a suggestion? Come and say, "Hello!"
5252

5353
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
5454
or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel,
5555
please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include
5656
details of how to access our Slack workspace. After you are logged in, please come to `#operator` and say, "hello!"
5757

58-
# Contributing to the operator
58+
## Contributing to the operator
5959

6060
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.
6161

6262
If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request.
6363

64-
If you have any questions about a possible submission, feel free to open an issue too.
64+
### Contributing to the WebLogic Kubernetes Operator repository
6565

66-
## Contributing to the WebLogic Kubernetes Operator repository
66+
Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md).
6767

68-
Pull requests can be made under The Oracle Contributor Agreement (OCA), which is available at [https://www.oracle.com/technetwork/community/oca-486395.html](https://www.oracle.com/technetwork/community/oca-486395.html).
69-
70-
For pull requests to be accepted, the bottom of the commit message must have the following line, using the contributor’s name and e-mail address as it appears in the OCA Signatories list.
68+
For pull requests to be accepted, the bottom of the commit message must have the following line, using the contributor’s name and e-mail address as it appears in the OCA Signatories List.
7169

7270
```
7371
Signed-off-by: Your Name <[email protected]>
@@ -81,14 +79,22 @@ git commit --signoff
8179

8280
Only pull requests from committers that can be verified as having signed the OCA can be accepted.
8381

84-
## Pull request process
82+
### Pull request process
8583

8684
* Fork the repository.
8785
* Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, for example, `1234-fixes`.
8886
* Ensure that any documentation is updated with the changes that are required by your fix.
8987
* Ensure that any samples are updated if the base image has been changed.
9088
* Submit the pull request. Do not leave the pull request blank. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes. Ensure that you reference the issue you created as well. We will assign the pull request to 2-3 people for review before it is merged.
9189

92-
## Introducing a new dependency
90+
### Introducing a new dependency
9391

9492
Please be aware that pull requests that seek to introduce a new dependency will be subject to additional review. In general, contributors should avoid dependencies with incompatible licenses, and should try to use recent versions of dependencies. Standard security vulnerability checklists will be consulted before accepting a new dependency. Dependencies on closed-source code, including WebLogic Server, will most likely be rejected.
93+
94+
95+
## License
96+
97+
Copyright (c) 2017, 2021 Oracle and/or its affiliates.
98+
99+
Released under the Universal Permissive License v1.0 as shown at
100+
<https://oss.oracle.com/licenses/upl/>.

0 commit comments

Comments
 (0)