|
1 | | -## My Project |
| 1 | +# OpenSearch documentation |
2 | 2 |
|
3 | | -TODO: Fill this README out! |
| 3 | +This repository contains the documentation for OpenSearch, the search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. You can find the rendered documentation at [docs-beta.opensearch.org](docs-beta.opensearch.org). |
4 | 4 |
|
5 | | -Be sure to: |
| 5 | +Community contributions remain essential in keeping this documentation comprehensive, useful, well-organized, and up-to-date. |
6 | 6 |
|
7 | | -* Change the title in this README |
8 | | -* Edit your repository description on GitHub |
9 | 7 |
|
10 | | -## Security |
| 8 | +## How you can help |
11 | 9 |
|
12 | | -See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. |
| 10 | +- Do you work on one of the various OpenSearch plugins? Take a look at the documentation for the plugin. Is everything accurate? Will anything change in the near future? |
13 | 11 |
|
14 | | -## License |
| 12 | + Often, engineering teams can keep existing documentation up-to-date with minimal effort, thus freeing up the documentation team to focus on larger projects. |
15 | 13 |
|
16 | | -This project is licensed under the Apache-2.0 License. |
| 14 | +- Do you have expertise in a particular area of OpenSearch? Cluster sizing? The query DSL? Painless scripting? Aggregations? JVM settings? Take a look at the [current content](https://docs-beta.opensearch.org/docs/opensearch/) and see where you can add value. The [documentation team](#points-of-contact) is happy to help you polish and organize your drafts. |
17 | 15 |
|
| 16 | +- Are you an OpenSearch Dashboards expert? How did you set up your visualizations? Why is a particular dashboard so valuable to your organization? We have [very little](https://docs-beta.opensearch.org/docs/opensearch-dashboards/) on how to use OpenSearch Dashboards, only how to install it. |
| 17 | + |
| 18 | +- Are you a web developer? Do you want to add an optional dark mode to the documentation? A "copy to clipboard" button for our code samples? Other improvements to the design or usability? See [major changes](#major-changes) for information on building the website locally. |
| 19 | + |
| 20 | +- Our [issue tracker](https://github.com/opensearch-project/documentation-website/issues) contains documentation bugs and other content gaps, some of which have colorful labels like "good first issue" and "help wanted." |
| 21 | + |
| 22 | + |
| 23 | +## Points of contact |
| 24 | + |
| 25 | +If you encounter problems or have questions when contributing to the documentation, these people can help: |
| 26 | + |
| 27 | +- [aetter](https://github.com/aetter) |
| 28 | +- [ashwinkumar12345](https://github.com/ashwinkumar12345) |
| 29 | +- [keithhc2](https://github.com/keithhc2) |
| 30 | +- [snyder114](https://github.com/snyder114) |
| 31 | + |
| 32 | + |
| 33 | +## How we build the website |
| 34 | + |
| 35 | +After each commit to this repository, GitHub Pages automatically uses [Jekyll](https://jekyllrb.com) to rebuild the [website](https://docs-beta.opensearch.org). The whole process takes around 30 seconds. |
| 36 | + |
| 37 | +This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website. For example, the Markdown file for [this page](https://docs-beta.opensearch.org/docs/opensearch/) is [here](https://github.com/opensearch-project/documentation-website/blob/master/docs/opensearch/index.md). |
| 38 | + |
| 39 | +Using plain text on GitHub has many advantages: |
| 40 | + |
| 41 | +- Everything is free, open source, and works on every operating system. Use your favorite text editor, Ruby, Jekyll, and Git. |
| 42 | +- Markdown is easy to learn and looks good in side-by-side diffs. |
| 43 | +- The workflow is no different than contributing code. Make your changes, build locally to check your work, and submit a pull request. Reviewers check the PR before merging. |
| 44 | +- Alternatives like wikis and WordPress are full web applications that require databases and ongoing maintenance. They also have inferior versioning and content review processes compared to Git. Static websites, such as the ones Jekyll produces, are faster, more secure, and more stable. |
| 45 | + |
| 46 | +In addition to the content for a given page, each Markdown file contains some Jekyll [front matter](https://jekyllrb.com/docs/front-matter/). Front matter looks like this: |
| 47 | + |
| 48 | +``` |
| 49 | +--- |
| 50 | +layout: default |
| 51 | +title: Alerting security |
| 52 | +nav_order: 10 |
| 53 | +parent: Alerting |
| 54 | +has_children: false |
| 55 | +--- |
| 56 | +``` |
| 57 | + |
| 58 | +If you're making [trivial changes](#trivial-changes), you don't have to worry about front matter. |
| 59 | + |
| 60 | +If you want to reorganize content or add new pages, keep an eye on `has_children`, `parent`, and `nav_order`, which define the hierarchy and order of pages in the lefthand navigation. For more information, see the documentation for [our upstream Jekyll theme](https://pmarsceill.github.io/just-the-docs/docs/navigation-structure/). |
| 61 | + |
| 62 | + |
| 63 | +## Contribute content |
| 64 | + |
| 65 | +There are three ways to contribute content, depending on the magnitude of the change. |
| 66 | + |
| 67 | +- [Trivial changes](#trivial-changes) |
| 68 | +- [Minor changes](#minor-changes) |
| 69 | +- [Major changes](#major-changes) |
| 70 | + |
| 71 | + |
| 72 | +### Trivial changes |
| 73 | + |
| 74 | +If you just need to fix a typo or add a sentence, this web-based method works well: |
| 75 | + |
| 76 | +1. On any page in the documentation, click the **Edit this page** link in the lower-left. |
| 77 | + |
| 78 | +1. Make your changes. |
| 79 | + |
| 80 | +1. Choose **Create a new branch for this commit and start a pull request** and **Commit changes**. |
| 81 | + |
| 82 | + |
| 83 | +### Minor changes |
| 84 | + |
| 85 | +If you want to add a few paragraphs across multiple files and are comfortable with Git, try this approach: |
| 86 | + |
| 87 | +1. Fork this repository. |
| 88 | + |
| 89 | +1. Download [GitHub Desktop](https://desktop.github.com), install it, and clone your fork. |
| 90 | + |
| 91 | +1. Navigate to the repository root. |
| 92 | + |
| 93 | +1. Create a new branch. |
| 94 | + |
| 95 | +1. Edit the Markdown files in `/docs`. |
| 96 | + |
| 97 | +1. Commit, push your changes to your fork, and submit a pull request. |
| 98 | + |
| 99 | + |
| 100 | +### Major changes |
| 101 | + |
| 102 | +If you're making major changes to the documentation and need to see the rendered HTML before submitting a pull request, here's how to build locally: |
| 103 | + |
| 104 | +1. Fork this repository. |
| 105 | + |
| 106 | +1. Download [GitHub Desktop](https://desktop.github.com), install it, and clone your fork. |
| 107 | + |
| 108 | +1. Navigate to the repository root. |
| 109 | + |
| 110 | +1. Install [Ruby](https://www.ruby-lang.org/en/) if you don't already have it. We recommend [RVM](https://rvm.io/), but use whatever method you prefer: |
| 111 | + |
| 112 | + ``` |
| 113 | + curl -sSL https://get.rvm.io | bash -s stable |
| 114 | + rvm install 2.6 |
| 115 | + ruby -v |
| 116 | + ``` |
| 117 | + |
| 118 | +1. Install [Jekyll](https://jekyllrb.com/) if you don't already have it: |
| 119 | + |
| 120 | + ``` |
| 121 | + gem install bundler jekyll |
| 122 | + ``` |
| 123 | + |
| 124 | +1. Install dependencies: |
| 125 | + |
| 126 | + ``` |
| 127 | + bundle install |
| 128 | + ``` |
| 129 | + |
| 130 | +1. Build: |
| 131 | + |
| 132 | + ``` |
| 133 | + sh build.sh |
| 134 | + ``` |
| 135 | + |
| 136 | +1. If the build script doesn't automatically open your web browser (it should), open [http://localhost:4000/](http://localhost:4000/). |
| 137 | + |
| 138 | +1. Create a new branch. |
| 139 | + |
| 140 | +1. Edit the Markdown files in `/docs`. |
| 141 | + |
| 142 | + If you're a web developer, you can customize `_layouts/default.html` and `_sass/custom/custom.scss`. |
| 143 | + |
| 144 | +1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process takes roughly 30 seconds. |
| 145 | + |
| 146 | +1. When you're happy with how everything looks, commit, push your changes to your fork, and submit a pull request. |
| 147 | + |
| 148 | + |
| 149 | +## Writing tips |
| 150 | + |
| 151 | +1. Try to stay consistent with existing content and consistent within your new content. Don't call the same plugin KNN, k-nn, and k-NN in three different places. |
| 152 | + |
| 153 | +1. Shorter paragraphs are better than longer paragraphs. Use headers, tables, lists, and images to make your content easier for readers to scan. |
| 154 | + |
| 155 | +1. Use **bold** for user interface elements, *italics* for key terms or emphasis, and `monospace` for Bash commands, file names, REST paths, and code. |
| 156 | + |
| 157 | +1. Markdown file names should be all lowercase, use hyphens to separate words, and end in `.md`. |
| 158 | + |
| 159 | +1. Avoid future tense. Use present tense. |
| 160 | + |
| 161 | + **Bad**: After you click the button, the process will start. |
| 162 | + |
| 163 | + **Better**: After you click the button, the process starts. |
| 164 | + |
| 165 | +1. "You" refers to the person reading the page. "We" refers to the OpenSearch contributors. |
| 166 | + |
| 167 | + **Bad**: Now that we've finished the configuration, we have a working cluster. |
| 168 | + |
| 169 | + **Better**: At this point, you have a working cluster, but we recommend adding dedicated master nodes. |
| 170 | + |
| 171 | +1. Don't use "this" and "that" to refer to something without adding a noun. |
| 172 | + |
| 173 | + **Bad**: This can cause high latencies. |
| 174 | + |
| 175 | + **Better**: This additional loading time can cause high latencies. |
| 176 | + |
| 177 | +1. Use active voice. |
| 178 | + |
| 179 | + **Bad**: After the request is sent, the data is added to the index. |
| 180 | + |
| 181 | + **Better**: After you send the request, the OpenSearch cluster indexes the data. |
| 182 | + |
| 183 | +1. Introduce acronyms before using them. |
| 184 | + |
| 185 | + **Bad**: Reducing customer TTV should accelerate our ROIC. |
| 186 | + |
| 187 | + **Better**: Reducing customer time to value (TTV) should accelerate our return on invested capital (ROIC). |
| 188 | + |
| 189 | +1. Spell out one through nine. Start using numerals at 10. If a number needs a unit (GB, pounds, millimeters, kg, celsius, etc.), use numerals, even if the number if smaller than 10. |
| 190 | + |
| 191 | + **Bad**: 3 kids looked for thirteen files on a six GB hard drive. |
| 192 | + |
| 193 | + **Better**: Three kids looked for 13 files on a 6 GB hard drive. |
| 194 | + |
| 195 | + |
| 196 | +## New releases |
| 197 | + |
| 198 | +1. Branch. |
| 199 | +1. Change the `opensearch_version` and `opensearch_major_version` variables in `_config.yml`. |
| 200 | +1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`. |
| 201 | +1. Update the version table in `version-history.md`. |
| 202 | + |
| 203 | + Use `curl -XGET https://localhost:9200 -u admin:admin -k` to verify the OpenSearch version. |
| 204 | + |
| 205 | +1. Update the plugin compatibility table in `docs/install/plugin.md`. |
| 206 | + |
| 207 | + Use `curl -XGET https://localhost:9200/_cat/plugins -u admin:admin -k` to get the correct version strings. |
| 208 | + |
| 209 | +1. Update the plugin compatibility table in `docs/opensearch-dashboards/plugins.md`. |
| 210 | + |
| 211 | + Use `docker ps` to find the ID for the OpenSearch Dashboards node. Then use `docker exec -it <opensearch-dashboards-node-id> /bin/bash` to get shell access. Finally, run `./bin/opensearch-dashboards-plugin list` to get the plugins and version strings. |
| 212 | + |
| 213 | +1. Run a build (`build.sh`), and look for any warnings or errors you introduced. |
| 214 | +1. Verify that the individual plugin download links in `docs/install/plugins.md` and `docs/opensearch-dashboards/plugins.md` work. |
| 215 | +1. Check for any other bad links (`check-links.sh`). Expect a few false positives for the `localhost` links. |
| 216 | +1. Submit a PR. |
| 217 | + |
| 218 | + |
| 219 | +## Classes within Markdown |
| 220 | + |
| 221 | +This documentation uses a modified version of the [just-the-docs](https://github.com/pmarsceill/just-the-docs) Jekyll theme, which has some useful classes for labels and buttons: |
| 222 | + |
| 223 | +``` |
| 224 | +[Get started](#get-started){: .btn .btn-blue } |
| 225 | +
|
| 226 | +## Get started |
| 227 | +New |
| 228 | +{: .label .label-green :} |
| 229 | +``` |
| 230 | + |
| 231 | +* Labels come in default (blue), green, purple, yellow, and red. |
| 232 | +* Buttons come in default, purple, blue, green, and outline. |
| 233 | +* Warning, tip, and note blocks are available (`{: .warning }`, etc.). |
| 234 | +* If an image has a white background, you can use `{: .img-border }` to add a one pixel border to the image. |
| 235 | + |
| 236 | +These classes can help with readability, but should be used *sparingly*. Each addition of a class damages the portability of the Markdown files and makes moving to a different Jekyll theme (or a different static site generator) more difficult. |
| 237 | + |
| 238 | +Besides, standard Markdown elements suffice for most documentation. |
| 239 | + |
| 240 | + |
| 241 | +## Math |
| 242 | + |
| 243 | +If you want to use the sorts of pretty formulas that [MathJax](https://www.mathjax.org) allows, add `has_math: true` to the Jekyll page metadata. Then insert LaTeX math into HTML tags with the rest of your Markdown content: |
| 244 | + |
| 245 | +``` |
| 246 | +## Math |
| 247 | +
|
| 248 | +Some Markdown paragraph. Here's a formula: |
| 249 | +
|
| 250 | +<p> |
| 251 | + When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are |
| 252 | + \[x = {-b \pm \sqrt{b^2-4ac} \over 2a}.\] |
| 253 | +</p> |
| 254 | +
|
| 255 | +And back to Markdown. |
| 256 | +``` |
| 257 | + |
| 258 | + |
| 259 | +## Code of conduct |
| 260 | + |
| 261 | +This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html). |
| 262 | + |
| 263 | + |
| 264 | +## Security issue notifications |
| 265 | + |
| 266 | +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. |
| 267 | + |
| 268 | + |
| 269 | +## Licensing |
| 270 | + |
| 271 | +See the [LICENSE](./LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. |
| 272 | + |
| 273 | + |
| 274 | +## Copyright |
| 275 | + |
| 276 | +Copyright Amazon.com, Inc. or its affiliates. All rights reserved. |
0 commit comments