本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。

Go to file

Andrew Ross a7df8220dd Add custom-codecs to list of bundled plugins (#5000 ) Signed-off-by: Andrew Ross <andrross@amazon.com>		2023-09-22 17:30:44 -04:00
.github	Add words to dictionary and modify rules (#5010 )	2023-09-13 10:33:09 -04: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	Add delimited term frequency token filter documentation (#5043 )	2023-09-22 17:30:22 -04:00
_api-reference	Add remote store buffer and index interval settings (#4973 )	2023-09-20 12:50:45 -05:00
_benchmark	Add new Bechmark IA (#5022 )	2023-09-20 12:51:22 -05:00
_clients	Update java-rest-high-level.md (#4880 )	2023-08-24 16:43:14 -07:00
_dashboards	[DOC] Create management section and advanced settings documentation (#4876 )	2023-09-20 11:08:18 -06:00
_data	Adds latest top navigation menu items from project site to 2.x version of docs site (#4960 )	2023-09-05 11:23:12 -07:00
_data-prepper	Update documentation for new AD settings (#4835 )	2023-09-21 15:07:38 -05:00
_developer-documentation	Add extensions documentation (#4202 )	2023-07-13 17:59:40 -04:00
_field-types	Add quantization techniques and links to byte vector (#4893 )	2023-08-29 13:45:19 -04:00
_im-plugin	Add a note about zstd incompatibility with k-NN and security analytics (#5014 )	2023-09-22 17:30:34 -04:00
_includes	Toc keyboard navigation (#4497 )	2023-07-17 10:11:42 -07:00
_install-and-configure	Add custom-codecs to list of bundled plugins (#5000 )	2023-09-22 17:30:44 -04:00
_integrations	[DOC] Add Integrations new documentation (#4546 )	2023-07-19 11:49:32 -06:00
_layouts	Toc keyboard navigation (#4497 )	2023-07-17 10:11:42 -07:00
_ml-commons-plugin	Add score normalization and combination documentation (#4985 )	2023-09-22 17:29:58 -04:00
_monitoring-your-cluster	Update logs.md (#4772 )	2023-08-14 13:19:10 -07:00
_observing-your-data	Add documentation for automatic Alerting workflows from detector creation (#5003 )	2023-09-19 14:45:37 -07:00
_plugins	Removed forced options, cleaned up link checker args. (#4726 )	2023-08-09 12:37:10 -04:00
_query-dsl	Add score normalization and combination documentation (#4985 )	2023-09-22 17:29:58 -04:00
_reporting	[DOC] Move Reporting to high-level section in nav menu (#4654 )	2023-07-31 10:13:35 -06:00
_sass	Toc keyboard navigation (#4497 )	2023-07-17 10:11:42 -07:00
_search-plugins	Add score normalization and combination documentation (#4985 )	2023-09-22 17:29:58 -04:00
_security	Adds documentation for permission that provides access to system indexes (#4849 )	2023-09-11 12:02:25 -07:00
_security-analytics	Add documentation for automatic Alerting workflows from detector creation (#5003 )	2023-09-19 14:45:37 -07:00
_tools	Remove steps for migrating cluster, targeted for later release (#5012 )	2023-09-13 13:39:16 -05:00
_troubleshoot	More redirects and spelling fixes (#4093 )	2023-05-17 09:57:14 -07:00
_tuning-your-cluster	Add remote store main page updates. Add shallow snapshots (#5078 )	2023-09-22 14:42:06 -05:00
_upgrade-to	Add Migrations - Capture and Replay release documentation (#4991 )	2023-09-12 14:17:32 -05:00
assets	Toc keyboard navigation (#4497 )	2023-07-17 10:11:42 -07:00
images	Add score normalization and combination documentation (#4985 )	2023-09-22 17:29:58 -04:00
release-notes	Add release notes 2.9 (#4605 )	2023-07-24 13:58:56 -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	Rewrite Contributing and readme (#4416 )	2023-07-19 12:36:37 -04:00
STYLE_GUIDE.md	Remove terms as inoffensive (#4983 )	2023-09-07 12:58:11 -04:00
TERMS.md	Add style guidelines and terms (#4734 )	2023-08-10 10:29:16 -04:00
THIRD-PARTY	Initial documentation cut	2021-05-05 10:09:47 -07:00
_config.yml	Split query DSL, analyzer, and aggregation sections and add more to analyzer section (#4693 )	2023-08-08 09:41:55 -04:00
about.md	Link fix (#3223 )	2023-03-06 11:41:22 -05:00
breaking-changes.md	Add breaking changes documentation for ES 6.8 to OS 1.x migration issues (#4856 )	2023-08-23 13:24:00 -07: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	Correct plugin capitalization (#3838 )	2023-05-04 11:11:54 -04:00
version-history.md	Add 1.3.13 to version history (#5063 )	2023-09-21 16:35:12 -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.