forked from opensearch-project/project-website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: dblock <dblock@amazon.com>
- Loading branch information
Showing
6 changed files
with
53 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Admins | ||
|
||
| Admin | GitHub ID | Affiliation | | ||
| --------------- | --------------------------------------- | ----------- | | ||
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon | | ||
|
||
[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins do in this repo. and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,4 @@ | ||
# Contributing Guidelines | ||
## Contributing to this Project | ||
|
||
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional | ||
documentation, we greatly value feedback and contributions from our community. | ||
|
||
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary | ||
information to effectively respond to your bug report or contribution. | ||
|
||
|
||
## Reporting Bugs/Feature Requests | ||
|
||
We welcome you to use the GitHub issue tracker to report bugs or suggest features. | ||
|
||
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already | ||
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: | ||
|
||
* A reproducible test case or series of steps | ||
* The version of our code being used | ||
* Any modifications you've made relevant to the bug | ||
* Anything unusual about your environment or deployment | ||
|
||
|
||
## Contributing via Pull Requests | ||
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: | ||
|
||
1. You are working against the latest source on the *main* branch. | ||
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. | ||
3. You open an issue to discuss any significant work - we would hate for your time to be wasted. | ||
|
||
To send us a pull request, please: | ||
|
||
1. Fork the repository. | ||
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. | ||
3. Ensure local tests pass. | ||
4. Commit to your fork using clear commit messages. | ||
5. Send us a pull request, answering any default questions in the pull request interface. | ||
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. | ||
|
||
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and | ||
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). | ||
|
||
|
||
## Finding contributions to work on | ||
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. | ||
|
||
|
||
## Code of Conduct | ||
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
opensource-codeofconduct@amazon.com with any additional questions or comments. | ||
|
||
|
||
## Security issue notifications | ||
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. | ||
|
||
|
||
## Licensing | ||
|
||
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
OpenSearch is a community project that is built and maintained by people just like **you**. | ||
[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
## Maintainers | ||
|
||
| Maintainer | GitHub ID | Affiliation | | ||
| --------------- | --------- | ----------- | | ||
| Kyle Davis | [stockholmux](https://github.com/stockholmux) | Amazon | | ||
| Eli Fisher | [elfisher](https://github.com/elfisher) | Amazon | | ||
|
||
[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,55 @@ | ||
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px"> | ||
|
||
- [opensearch.org website](#opensearchorg-website) | ||
- [OpenSearch.org Website](#opensearchorg-website) | ||
- [Getting Help](#getting-help) | ||
- [Contributing](#contributing) | ||
- [Adding to the Partners Page](#adding-to-the-partners-page) | ||
- [Building the Website](#building-the-website) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Security](#security) | ||
- [License](#license) | ||
- [Build](#build) | ||
- [Credits](#credits) | ||
|
||
# opensearch.org website | ||
# OpenSearch.org Website | ||
|
||
This repo contains the source for the opensearch.org website. | ||
This repo contains the source for the [opensearch.org](https://opensearch.org/) website. | ||
|
||
## Getting Help | ||
|
||
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. | ||
|
||
If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/). | ||
|
||
## Contributing | ||
|
||
We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) page to learn more about how to contribute to the website. | ||
|
||
### Adding to the Partners Page | ||
|
||
If you are a partner, you are welcome to add your logo/link to our partners page. See the [sample file](https://github.com/opensearch-project/project-website/blob/staging/_partners/_sample.md) and submit a pull request. | ||
If you are a partner, you are welcome to add your logo/link to our partners page. Please copy and edit the [sample file](_partners/_sample.md), and submit a pull request. | ||
|
||
## Security | ||
### Building the Website | ||
|
||
If you discover potential security issues, see the reporting instructions on our [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) page for more information. | ||
This site uses [Jekyll](https://jekyllrb.com/). You can build the site and make it available on a local server via `docker-compose up -d`, or by installing all the dependencies on your local environment as follows. | ||
|
||
## License | ||
1. Install [Ruby](https://www.ruby-lang.org/en/) and run `bundle install`. | ||
2. Build and start Jekyll with `bundle exec jekyll serve`. | ||
3. Browse the site at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). | ||
|
||
This project is licensed under the BSD-3-Clause License. | ||
Alternatively, build the site with `bundle exec jekyll build`. The HTML output is generated into `/_site`. | ||
|
||
## Build | ||
## Code of Conduct | ||
|
||
You can build the site and make it available on a local server via: | ||
``` | ||
docker-compose up -d | ||
``` | ||
or by installing all the dependencies on your local environment: | ||
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. | ||
|
||
1. Go to the root of the repo | ||
2. Install [Ruby](https://www.ruby-lang.org/en/) | ||
3. Install [Jekyll](https://jekyllrb.com/) | ||
4. Install dependencies: `bundle install` | ||
5. Build: `bundle exec jekyll serve` for the local server, `bundle exec jekyll build` for one off builds. Either way, the HTML of the site is generated to `/_site`. | ||
## Security | ||
|
||
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. | ||
|
||
## License | ||
|
||
Browse the site at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). | ||
This project is licensed under the [BSD-3-Clause License](LICENSE). | ||
|
||
## Credits | ||
|
||
This website was forked from the BSD-licensed [djangoproject.com](https://github.com/django/djangoproject.com) | ||
This website was forked from the BSD-licensed [djangoproject.com](https://github.com/django/djangoproject.com). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Reporting a Vulnerability | ||
|
||
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to aws-security@amazon.com. Please do **not** create a public GitHub issue. |