|
1 | 1 | <img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">
|
2 | 2 |
|
3 |
| -- [opensearch.org website](#opensearchorg-website) |
| 3 | +- [OpenSearch.org Website](#opensearchorg-website) |
| 4 | + - [Getting Help](#getting-help) |
4 | 5 | - [Contributing](#contributing)
|
5 | 6 | - [Adding to the Partners Page](#adding-to-the-partners-page)
|
| 7 | + - [Building the Website](#building-the-website) |
| 8 | + - [Code of Conduct](#code-of-conduct) |
6 | 9 | - [Security](#security)
|
7 | 10 | - [License](#license)
|
8 |
| - - [Build](#build) |
9 | 11 | - [Credits](#credits)
|
10 | 12 |
|
11 |
| -# opensearch.org website |
| 13 | +# OpenSearch.org Website |
12 | 14 |
|
13 |
| -This repo contains the source for the opensearch.org website. |
| 15 | +This repo contains the source for the [opensearch.org](https://opensearch.org/) website. |
| 16 | + |
| 17 | +## Getting Help |
| 18 | + |
| 19 | +If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. |
| 20 | + |
| 21 | +If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/). |
14 | 22 |
|
15 | 23 | ## Contributing
|
16 | 24 |
|
17 | 25 | We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) page to learn more about how to contribute to the website.
|
18 | 26 |
|
19 | 27 | ### Adding to the Partners Page
|
20 | 28 |
|
21 |
| -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. |
| 29 | +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. |
22 | 30 |
|
23 |
| -## Security |
| 31 | +### Building the Website |
24 | 32 |
|
25 |
| -If you discover potential security issues, see the reporting instructions on our [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) page for more information. |
| 33 | +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. |
26 | 34 |
|
27 |
| -## License |
| 35 | +1. Install [Ruby](https://www.ruby-lang.org/en/) and run `bundle install`. |
| 36 | +2. Build and start Jekyll with `bundle exec jekyll serve`. |
| 37 | +3. Browse the site at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). |
28 | 38 |
|
29 |
| -This project is licensed under the BSD-3-Clause License. |
| 39 | +Alternatively, build the site with `bundle exec jekyll build`. The HTML output is generated into `/_site`. |
30 | 40 |
|
31 |
| -## Build |
| 41 | +## Code of Conduct |
32 | 42 |
|
33 |
| -You can build the site and make it available on a local server via: |
34 |
| -``` |
35 |
| -docker-compose up -d |
36 |
| -``` |
37 |
| -or by installing all the dependencies on your local environment: |
| 43 | +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. |
38 | 44 |
|
39 |
| -1. Go to the root of the repo |
40 |
| -2. Install [Ruby](https://www.ruby-lang.org/en/) |
41 |
| -3. Install [Jekyll](https://jekyllrb.com/) |
42 |
| -4. Install dependencies: `bundle install` |
43 |
| -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`. |
| 45 | +## Security |
| 46 | + |
| 47 | +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. |
| 48 | + |
| 49 | +## License |
44 | 50 |
|
45 |
| -Browse the site at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). |
| 51 | +This project is licensed under the [BSD-3-Clause License](LICENSE). |
46 | 52 |
|
47 | 53 | ## Credits
|
48 | 54 |
|
49 |
| -This website was forked from the BSD-licensed [djangoproject.com](https://github.com/django/djangoproject.com) |
| 55 | +This website was forked from the BSD-licensed [djangoproject.com](https://github.com/django/djangoproject.com). |
0 commit comments