Skip to content

Commit 4598f87

Browse files
committed
Update project root files based on latest template
1 parent 0060096 commit 4598f87

File tree

5 files changed

+151
-72
lines changed

5 files changed

+151
-72
lines changed

CONTRIBUTING.md

+55-31
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,55 @@
1-
---
2-
3-
---
4-
5-
# Source Code Submissions
6-
We welcome your contributions and look forward to collaborating with you. We can only accept source code repository
7-
submissions from users who have signed and returned the Oracle
8-
Contributor Agreement. You will find details and the agreement to sign at this OTN web page:
9-
[Oracle Contributor Agreement](http://www.oracle.com/technetwork/community/oca-486395.html).
10-
11-
# Other Contributions
12-
For all project Submissions other than source code repository contributions, the following also applies: Oracle does
13-
not claim ownership of Your Submissions. However, in order to fulfill
14-
the purposes of this project, You must give Oracle and all Users
15-
the right to post, access, discuss, use, publish, disseminate, and refine
16-
Your Submissions.
17-
18-
In legalese: *You hereby grant to Oracle and all
19-
Users a royalty-free, perpetual, irrevocable, worldwide, non-exclusive,
20-
and fully sub-licensable right and license, under Your intellectual
21-
property rights, to reproduce, modify, adapt, publish, translate, create
22-
derivative works from, distribute, perform, display, and use Your
23-
Submissions (in whole or part) and to incorporate or implement them in
24-
other works in any form, media, or technology now known or later
25-
developed, all subject to the obligation to retain any copyright notices
26-
included in Your Submissions. All Users, Oracle, and their
27-
sublicensees are responsible for any modifications they make to the
28-
Submissions of others.*
29-
30-
Copyright 2017, 2019, Oracle and/or its affiliates.
31-
Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
1+
# Contributing to this repository
2+
3+
We welcome your contributions! There are multiple ways to contribute.
4+
5+
## Opening issues
6+
7+
For bugs or enhancement requests, please file a GitHub issue unless it's
8+
security related. When filing a bug remember that the better written the bug is,
9+
the more likely it is to be fixed. If you think you've found a security
10+
vulnerability, do not raise a GitHub issue and follow the instructions in our
11+
[security policy](./SECURITY.md).
12+
13+
## Contributing code
14+
15+
We welcome your code contributions. Before submitting code via a pull request,
16+
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
17+
your commits need to include the following line using the name and e-mail
18+
address you used to sign the OCA:
19+
20+
```text
21+
Signed-off-by: Your Name <[email protected]>
22+
```
23+
24+
This can be automatically added to pull requests by committing with `--sign-off`
25+
or `-s`, e.g.
26+
27+
```text
28+
git commit --signoff
29+
```
30+
31+
Only pull requests from committers that can be verified as having signed the OCA
32+
can be accepted.
33+
34+
## Pull request process
35+
36+
1. Ensure there is an issue created to track and discuss the fix or enhancement
37+
you intend to submit.
38+
1. Fork this repository
39+
1. Create a branch in your fork to implement the changes. We recommend using
40+
the issue number as part of your branch name, e.g. `1234-fixes`
41+
1. Ensure that any documentation is updated with the changes that are required
42+
by your change.
43+
1. Ensure that any samples are updated if the base image has been changed.
44+
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
45+
what your changes are meant to do and provide simple steps on how to validate
46+
your changes. Ensure that you reference the issue you created as well.
47+
1. We will assign the pull request to 2-3 people for review before it is merged.
48+
49+
## Code of conduct
50+
51+
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
52+
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
53+
54+
[OCA]: https://oca.opensource.oracle.com
55+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

LICENSE

-30
This file was deleted.

LICENSE.txt

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Copyright (c) 2021 Oracle and/or its affiliates.
2+
3+
The Universal Permissive License (UPL), Version 1.0
4+
5+
Subject to the condition set forth below, permission is hereby granted to any
6+
person obtaining a copy of this software, associated documentation and/or data
7+
(collectively the "Software"), free of charge and under any and all copyright
8+
rights in the Software, and any and all patent rights owned or freely
9+
licensable by each licensor hereunder covering either (i) the unmodified
10+
Software as contributed to or provided by such licensor, or (ii) the Larger
11+
Works (as defined below), to deal in both
12+
13+
(a) the Software, and
14+
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
15+
one is included with the Software (each a "Larger Work" to which the Software
16+
is contributed by such licensors),
17+
18+
without restriction, including without limitation the rights to copy, create
19+
derivative works of, display, perform, and distribute the Software and make,
20+
use, sell, offer for sale, import, export, have made, and have sold the
21+
Software and the Larger Work(s), and to sublicense the foregoing rights on
22+
either these or other terms.
23+
24+
This license is subject to the following condition:
25+
The above copyright notice and either this complete permission notice or at
26+
a minimum a reference to the UPL must be included in all copies or
27+
substantial portions of the Software.
28+
29+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35+
SOFTWARE.

README.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
WebLogic Monitoring Exporter
2-
=====
1+
# WebLogic Monitoring Exporter
32

43
[![Build Status](https://travis-ci.org/oracle/weblogic-monitoring-exporter.svg?branch=master)](https://travis-ci.org/oracle/weblogic-monitoring-exporter)
54

@@ -127,11 +126,11 @@ include the `restPort` configuration to tell the exporter which port to use.
127126
* [Chart-based sample](samples/kubernetes/end2end): This is an end-to-end sample that shows you the steps to set up monitoring for WebLogic domains using Prometheus and Grafana. Prometheus and Grafana are installed with Helm charts.
128127

129128

130-
# Web application
129+
### Web application
131130

132131
One way to use the exporter is by creating a WAR file with a default configuration and deploying it to a WebLogic Server instance.
133132

134-
## Setting the configuration
133+
#### Setting the configuration
135134

136135
The web application has a main landing page, which displays the current [configuration](#configuration) and allows
137136
you to change it, either by uploading a replacement or an addition to the queries specified with the current one.
@@ -156,11 +155,11 @@ is the Maven-assigned version number.
156155
Adding `-Dconfiguration=<some-config-file>` will insert the specified configuration as its default and remove
157156
the version number to simplify deployment to WebLogic Server.
158157

159-
# Sidecar
158+
## Sidecar
160159

161160
The sidecar is a standalone process that runs the exporter.
162161

163-
## Build and run with Maven
162+
### Build and run with Maven
164163

165164
There are two ways to build the sidecar implementation. The first is with Maven, using the same `mvn install` command
166165
specified [above](#building-from-source). Note that this requires JDK11 or later; building the project with JDK8 will
@@ -183,7 +182,7 @@ WebLogic host | `localhost` | `WLS_HOST`
183182
WebLogic port | `7001` | `WLS_PORT`
184183
Use https | `false` | `WLS_SECURE`
185184

186-
## Configure the exporter
185+
### Configure the exporter
187186

188187
You configure the sidecar by sending a PUT request to the path `/configuration`.
189188
You can do this with `curl`; that is how the operator does it.
@@ -223,8 +222,19 @@ docker build . --build-arg MAVEN_OPTS="-Dhttps.proxyHost=www-proxy -Dhttps.proxy
223222
This allows Docker to download the dependencies.
224223

225224

226-
227-
## Copyright
225+
## Contributing
226+
227+
This project welcomes contributions from the community. Before submitting a pull
228+
request, please [review our contribution guide](./CONTRIBUTING.md).
229+
230+
## Security
231+
232+
Please consult the [security guide](./SECURITY.md) for our responsible security
233+
vulnerability disclosure process.
234+
235+
## License
236+
237+
Copyright (c) 2019, 2021 Oracle and/or its affiliates.
228238

229-
Copyright &copy; 2017, 2021, Oracle and/or its affiliates.
230-
Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
239+
Released under the Universal Permissive License v1.0 as shown at
240+
<https://oss.oracle.com/licenses/upl/>.

SECURITY.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Reporting security vulnerabilities
2+
3+
Oracle values the independent security research community and believes that
4+
responsible disclosure of security vulnerabilities helps us ensure the security
5+
and privacy of all our users.
6+
7+
Please do NOT raise a GitHub Issue to report a security vulnerability. If you
8+
believe you have found a security vulnerability, please submit a report to
9+
[[email protected]][1] preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][2].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][3].
13+
14+
We ask that you do not use other channels or contact the project maintainers
15+
directly.
16+
17+
Non-vulnerability related security issues including ideas for new or improved
18+
security features are welcome on GitHub Issues.
19+
20+
## Security updates, alerts and bulletins
21+
22+
Security updates will be released on a regular cadence. Many of our projects
23+
will typically release security fixes in conjunction with the
24+
[Oracle Critical Patch Update][3] program. Security updates are released on the
25+
Tuesday closest to the 17th day of January, April, July and October. A pre-release
26+
announcement will be published on the Thursday preceding each release. Additional
27+
information, including past advisories, is available on our [security alerts][4]
28+
page.
29+
30+
## Security-related information
31+
32+
We will provide security related information such as a threat model, considerations
33+
for secure use, or any known security issues in our documentation. Please note
34+
that labs and sample code are intended to demonstrate a concept and may not be
35+
sufficiently hardened for production use.
36+
37+
[1]: mailto:[email protected]
38+
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
39+
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
40+
[4]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)