本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
Go to file
Chris Moore 67cabe1ec5
Add documentation for config file settings (#4058)
* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 os.yml config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#214 config file settings

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Refactor settings documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add more settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* remove bad commits (#5505)

Signed-off-by: Stephen Crawford <steecraw@amazon.com>

* Format security settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add plugin settings and dashboards settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Specify json code highlighter

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add gateway and network settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Change heading level

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Heading text change

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix link

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add Notifications plugin settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented tech review comments for search settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Rename directory and implement latest search setting review comment

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove non-existent ml circuit breaker settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add file system and s3 settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update nav order

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add security analytics settings and specify static/dynamic for security settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reword correlation time window

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented tech review comments for network and discovery settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Clarify security settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _install-and-configure/configuring-opensearch/security-settings.md

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Add cross links to static and dynamic settings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix link

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
2023-11-16 16:33:15 -05:00
.github Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_aggregations Split query DSL, analyzer, and aggregation sections and add more to analyzer section (#4693) 2023-08-08 09:41:55 -04:00
_analyzers chnaging HyphenationCompoundWordTokenFilter link from v8.7 to 9.8 (#5422) 2023-10-31 09:33:17 -05:00
_api-reference Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_benchmark Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_clients [Fix typo] Fix typo on java.md sample code (#5567) 2023-11-14 11:14:51 -06:00
_dashboards Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_data Revert "Redesigned top nav and footer (#5113)" (#5560) 2023-11-09 14:25:32 -06:00
_data-prepper [DOC] Fix rename processor 'otel_trace' to 'otel_traces' (#5423) 2023-11-07 14:48:11 -06:00
_developer-documentation Add extensions documentation (#4202) 2023-07-13 17:59:40 -04:00
_field-types Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_im-plugin Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_includes Revert "Redesigned top nav and footer (#5113)" (#5560) 2023-11-09 14:25:32 -06:00
_ingest-pipelines Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_install-and-configure Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_integrations [DOC] Add Integrations new documentation (#4546) 2023-07-19 11:49:32 -06:00
_layouts Revert "Redesigned top nav and footer (#5113)" (#5560) 2023-11-09 14:25:32 -06:00
_ml-commons-plugin Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_monitoring-your-cluster Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_observing-your-data Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_plugins Removed forced options, cleaned up link checker args. (#4726) 2023-08-09 12:37:10 -04:00
_query-dsl Change name of normalization processor in text (#5611) 2023-11-16 11:25:44 -05:00
_reporting [DOC] Move Reporting to high-level section in nav menu (#4654) 2023-07-31 10:13:35 -06:00
_sass Revert "Redesigned top nav and footer (#5113)" (#5560) 2023-11-09 14:25:32 -06:00
_search-plugins Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_security Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_security-analytics Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_tools Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_troubleshoot More redirects and spelling fixes (#4093) 2023-05-17 09:57:14 -07:00
_tuning-your-cluster Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_upgrade-to Add Migrations - Capture and Replay release documentation (#4991) 2023-09-12 14:17:32 -05:00
assets Revert "Redesigned top nav and footer (#5113)" (#5560) 2023-11-09 14:25:32 -06:00
images [DOC] Add new documentation about Query Workbench (#5378) 2023-11-02 16:39:35 -06:00
release-notes Add release notes 2.11 (#5210) 2023-10-16 14:27:42 -04:00
templates Update API_TEMPLATE.md (#4261) 2023-06-06 22:02:00 -04:00
.gitignore Remove script from gitignore (#3295) 2023-03-08 15:19:34 -05:00
.vale.ini Update style workflow (#4472) 2023-07-05 10:01:16 -04:00
404.md Final text for 404 (#4302) 2023-06-13 07:44:22 -07:00
API_STYLE_GUIDE.md Add API and experimetal templates (#4258) 2023-06-06 18:13:45 -04:00
CNAME Create CNAME 2021-05-07 12:13:42 -07:00
CODE_OF_CONDUCT.md Initial commit 2021-05-03 10:11:12 -07:00
CONTRIBUTING.md Rewrite Contributing and readme (#4416) 2023-07-19 12:36:37 -04:00
FORMATTING_GUIDE.md Update FORMATTING_GUIDE.md with link to code samples in style guide (#4709) 2023-08-07 11:50:46 -07:00
Gemfile Removed forced options, cleaned up link checker args. (#4726) 2023-08-09 12:37:10 -04:00
LICENSE Initial commit 2021-05-03 10:11:12 -07:00
MAINTAINERS.md Updates to repo (#3882) 2023-04-26 17:34:08 -07:00
NOTICE Remove year from copyright 2021-08-09 15:53:52 -07:00
README.md Remove Chris from repo contacts (#5170) 2023-10-06 14:33:17 -04:00
STYLE_GUIDE.md Add CRUD to acronyms (#5205) 2023-10-16 09:34:18 -04:00
TERMS.md Add two terms (#5185) 2023-10-11 09:10:38 -04:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml [DOC] Change navigation for better usability (#5227) 2023-10-17 15:22:28 -06:00
about.md [OSCI][DOCs] Replacing 'indices' terms for 'indexes' terms ONLY for description texts (#5353) 2023-10-31 10:18:45 -05:00
breaking-changes.md Add wildcard query breaking change (#5271) 2023-10-18 11:21:29 -04:00
build.sh Add CI with link checker. (#3584) 2023-04-04 15:49:27 -04:00
check-links.sh Add CI with link checker. (#3584) 2023-04-04 15:49:27 -04:00
favicon.ico Initial documentation cut 2021-05-05 10:09:47 -07:00
favicon.png Initial documentation cut 2021-05-05 10:09:47 -07:00
favicon.svg Initial documentation cut 2021-05-05 10:09:47 -07:00
index.md Fixes to redirects (#4195) 2023-05-26 14:48:31 -07:00
quickstart.md Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
version-history.md Add 2.11 to version history (#5208) 2023-10-16 14:27:21 -04:00

README.md

About the OpenSearch documentation repo

The documentation-website repository contains the user documentation for OpenSearch. You can find the rendered documentation at opensearch.org/docs.

Contributing

Community contributions remain essential to keeping the documentation comprehensive, useful, well organized, and up to date. If you are interested in submitting an issue or contributing content, see CONTRIBUTING.

The following resources provide important guidance regarding contributions to the documentation:

  • OpenSearch Project Style Guidelines -- The style guide covers the style standards to be observed when creating OpenSearch Project content.
  • OpenSearch terms -- The terms list contains key OpenSearch terms and tips on how and when to use them.
  • API Style Guide -- The API Style Guide provides the basic structure for creating OpenSearch API documentation.
  • Formatting Guide -- The OpenSearch documentation uses a modified version of the just-the-docs Jekyll theme. The Formatting Guide provides an overview of the commonly used formatting elements and how to add a page to the website.

Points of contact

If you encounter problems or have questions when contributing to the documentation, these people can help:

Code of conduct

This project has adopted an Open Source Code of Conduct.

Security

If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security using our vulnerability reporting page. Do not create a public GitHub issue.

License

This project is licensed under the Apache 2.0 License.

Copyright OpenSearch contributors.