Merge pull request #45 from oracle/LesiaChaban-patch-1

dpetersonx · web-flow · commit a20ce81d27b2 · 2024-07-24T08:54:40.000-07:00
Update documentation with the OGHO requirements
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing to this repository
+
+We welcome your contributions! There are multiple ways to contribute.
+
+## Opening issues
+
+For bugs or enhancement requests, please file a GitHub issue unless it's
+security related. When filing a bug remember that the better written the bug is,
+the more likely it is to be fixed. If you think you've found a security
+vulnerability, do not raise a GitHub issue and follow the instructions in our
+[security policy](./SECURITY.md).
+
+## Contributing code
+
+We welcome your code contributions. Before submitting code via a pull request,
+you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
+your commits need to include the following line using the name and e-mail
+address you used to sign the OCA:
+
+```text
+Signed-off-by: Your Name <you@example.org>
+```
+
+This can be automatically added to pull requests by committing with `--sign-off`
+or `-s`, e.g.
+
+```text
+git commit --signoff
+```
+
+Only pull requests from committers that can be verified as having signed the OCA
+can be accepted.
+
+## Pull request process
+
+1. Ensure there is an issue created to track and discuss the fix or enhancement
+   you intend to submit.
+1. Fork this repository.
+1. Create a branch in your fork to implement the changes. We recommend using
+   the issue number as part of your branch name, e.g. `1234-fixes`.
+1. Ensure that any documentation is updated with the changes that are required
+   by your change.
+1. Ensure that any samples are updated if the base image has been changed.
+1. 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.
+1. We will assign the pull request to 2-3 people for review before it is merged.
+
+## Code of conduct
+
+Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
+like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
+
+[OCA]: https://oca.opensource.oracle.com
+[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,38 @@
+# Reporting security vulnerabilities
+
+Oracle values the independent security research community and believes that
+responsible disclosure of security vulnerabilities helps us ensure the security
+and privacy of all our users.
+
+Please do NOT raise a GitHub Issue to report a security vulnerability. If you
+believe you have found a security vulnerability, please submit a report to
+[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
+some additional information on [how to report security vulnerabilities to Oracle][2].
+We encourage people who contact Oracle Security to use email encryption using
+[our encryption key][3].
+
+We ask that you do not use other channels or contact the project maintainers
+directly.
+
+Non-vulnerability related security issues including ideas for new or improved
+security features are welcome on GitHub Issues.
+
+## Security updates, alerts and bulletins
+
+Security updates will be released on a regular cadence. Many of our projects
+will typically release security fixes in conjunction with the
+Oracle Critical Patch Update program. Additional
+information, including past advisories, is available on our [security alerts][4]
+page.
+
+## Security-related information
+
+We will provide security related information such as a threat model, considerations
+for secure use, or any known security issues in our documentation. Please note
+that labs and sample code are intended to demonstrate a concept and may not be
+sufficiently hardened for production use.
+
+[1]: mailto:secalert_us@oracle.com
+[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
+[3]: https://www.oracle.com/security-alerts/encryptionkey.html
+[4]: https://www.oracle.com/security-alerts/
diff --git a/react-starter-sites/LICENSE.md b/react-starter-sites/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright (c) 2017,2018 Oracle and/or its affiliates
+Copyright (c) 2017,2024 Oracle and/or its affiliates
 
  
 
@@ -26,4 +26,4 @@ The above copyright notice and either this complete permission notice or at a mi
 
  
 
-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. 
+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. 
diff --git a/react-starter-sites/README.md b/react-starter-sites/README.md
@@ -47,8 +47,8 @@ To create a site to show CEC content, you need to specify the source of the cont
 
 	You can use command `cecss export-server-content` to export all published content items from a channel, then use the generated zip file to create a site.
 
-3.	The live content on a CEC server
-
+3.	The live content on a CEC server
+
 	Example  content has been provided in `StarterBlog_export.zip`
 
 # Set up CEC Server Connection
@@ -79,7 +79,7 @@ Run command  `cecss create-site -h` to see the usage:
 
 ```
 Usage: cec create-site <name>
-```
+```
 
 Creates the Site <name> for the content from local or from CEC server. By default, it creates a StarterSite. Optionally specify -f <source> to create from different source.
 
@@ -92,14 +92,14 @@ Options:
   --locales, -l   <locales> The comma separated list of locales, the first one in the list will be the default locale for the site
   --help, -h      Show help                                                                                                                                                [boolean]
 
-Examples:
-
+Examples:
+
 ```
 cecss create-site NewsSite -c StarterBlog_export.zip
 cecss create-site NewsSite -f ~/Downloads/ReactSiteTemplate.zip -c ~/Downloads/NewsTemplate.zip
 cecss create-site BlogSite -s -n Blog
 cecss create-site BlogSite -s -n Blog -t Blog,Author
-cecss create-site NewsSite -c ~/Downloads/NewsTemplate.zip -l fr-FR,it-IT,de-DE
+cecss create-site NewsSite -c ~/Downloads/NewsTemplate.zip -l fr-FR,it-IT,de-DE
 cecss create-site BlogSite -s -n Blog -l en-US,zh-CN
 ```
 
@@ -376,3 +376,18 @@ For each field object, we support following tags
 | `{{__render.reference}}` | a boolean flag to indicate the field is a reference to another item, you can render this field as a link pointing to the referenced item |
 
 When create site template zip file, make sure not to include the top level folder.
+
+## Contributing
+
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](../CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](../SECURITY.md) for our responsible security vulnerability disclosure process
+
+## License
+
+Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+
+Released under the Universal Permissive License v1.0 as shown at
+<https://oss.oracle.com/licenses/upl/>.
diff --git a/sites/LICENSE.md b/sites/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright (c) 2019, 2022 Oracle and/or its affiliates
+Copyright (c) 2019, 2024 Oracle and/or its affiliates
 
  
 
diff --git a/sites/README.MD b/sites/README.MD
@@ -102,4 +102,18 @@ Instructions on how to setup the IAM application for headless CLI are [here](doc
 ## Using an IDCS Application to access CEC Instance to have a CLI without Chromium popup for Authentication
 Instructions on how to setup the IDCS application for headless CLI are [here](doc/IDCS-App.md)
 
+## Contributing
+
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](../CONTRIBUTING.md)
+
+## Security
+
+Please consult the [security guide](../SECURITY.md) for our responsible security vulnerability disclosure process
+
+## License
+
+Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+
+Released under the Universal Permissive License v1.0 as shown at
+<https://oss.oracle.com/licenses/upl/>.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2019, 2022 Oracle and/or its affiliates`
	`1`	`+Copyright (c) 2019, 2024 Oracle and/or its affiliates`
`2`	`2`
`3`	`3`
`4`	`4`