Skip to content

Commit f5c0ede

Browse files
athulmuraliathulmurali
authored
Updated instructions to match OGHO standards (#81)
 * Updated readme and added files to meet OGHO standards
1 parent d92e7e3 commit f5c0ede

File tree

4 files changed

+151
-11
lines changed

4 files changed

+151
-11
lines changed

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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 haved 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 <you@example.org>
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+
2. Fork this repository
39+
3. 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+
4. Ensure that any documentation is updated with the changes that are required
42+
by your change.
43+
5. Ensure that any samples are updated if the base image has been changed.
44+
6. 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+
7. 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://www.oracle.com/technetwork/community/oca-486395.html
55+
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

‎LICENSE.txt‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1-
Copyright © 2019, Oracle and/or its affiliates. All rights reserved.
1+
Copyright (c) 2021 Oracle and/or its affiliates.
22

33
The Universal Permissive License (UPL), Version 1.0
44

5-
Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
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
612

713
(a) the Software, and
8-
(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a “Larger Work” to which the Software is contributed by such licensors),
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),
917

10-
without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
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.
1123

1224
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.
1328

14-
The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
15-
16-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Oracle Cloud Infrastructure Metrics Data Source
1+
# About OCI Grafana Metrics plugin
2+
3+
4+
## Installation
5+
6+
### Oracle Cloud Infrastructure Metrics Data Source
27
## Introduction
38

49
This plugin makes queries to the Oracle Cloud Infrastructure Monitoring Service and displays them on Grafana.
@@ -11,7 +16,6 @@ If you are running Grafana anywhere else, make sure you have `~/.oci` configured
1116

1217
If you're using a version of Grafana that's older than 6.0, you will need to download the zip file and install this plugin manually, or chmod the binary that is downloaded to make it executable.
1318

14-
## Installation Documentation
1519

1620
In order to simplify the installation process, we created detailed guides for you to follow:
1721

@@ -25,12 +29,35 @@ Once you have the data source installed, configure your datasource with your ten
2529

2630
We also have documentation for how to use the newly installed and configured plugin in our [Using Grafana with Oracle Cloud Infrastructure Data Source](https://github.com/oracle/oci-grafana-plugin/blob/master/docs/using.md) walkthrough.
2731

28-
## Development
29-
3032
### Debugging
3133

3234
If you want to debug golang backend plugin code, follow the steps below:
3335
* Install [gops](https://github.com/google/gops) to list running go processes on your machine
3436
* Run `gops` and find processId for `oci-plugin_darwin_amd64` process
3537
* Copy this processId to the `.vscode/launch.json`
3638
* In your VSCode from 'Debug' menu call 'Start Debugging'
39+
40+
## Documentation
41+
42+
Please refer to the [docs folder in this repo](./docs)
43+
44+
## Help
45+
46+
Issues and questions about this plugin can be posted [as an issue in this GitHub repository](https://github.com/oracle/oci-grafana-plugin/issues)
47+
48+
## Contributing
49+
50+
This project welcomes contributions from the community. Before submitting a pull
51+
request, please [review our contribution guide](./CONTRIBUTING.md).
52+
53+
## Security
54+
55+
Please consult the [security guide](./SECURITY.md) for our responsible security
56+
vulnerability disclosure process.
57+
58+
## License
59+
60+
Copyright (c) 2021 Oracle and/or its affiliates.
61+
62+
Released under the Universal Permissive License v1.0 as shown at
63+
<https://oss.oracle.com/licenses/upl/>.

‎SECURITY.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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+
<mailto:secalert_us@oracle.com> preferably with a proof of concept. Please review
10+
some additional information on [how to report security vulnerabilities to Oracle][1].
11+
We encourage people who contact Oracle Security to use email encryption using
12+
[our encryption key][2].
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][3]
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]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
38+
[2]: https://www.oracle.com/security-alerts/encryptionkey.html
39+
[3]: https://www.oracle.com/security-alerts/

0 commit comments

Comments
 (0)