本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
Go to file
Carlos Neto a1ac25a29d
* [DOC] Added 'Search' nodes description in 'Creating a cluster' page (#4597)
* [DOC] fix the tabulation of searchable snapshots snippet example

Signed-off-by: Carlos Neto <carlos.neto.dev@gmail.com>
2023-07-28 13:15:26 -04:00
.github Add rerank and its versions to style workflow (#4573) 2023-07-14 17:05:21 -04:00
_api-reference Add index codec documentation (#4589) 2023-07-21 16:10:18 -04:00
_benchmark Add index codec documentation (#4589) 2023-07-21 16:10:18 -04:00
_clients demonstrate fluent queries to exclude fields with empty values (#4579) 2023-07-18 10:08:56 -07:00
_dashboards Add index codec documentation (#4589) 2023-07-21 16:10:18 -04:00
_data Add 2.9 version (#4590) 2023-07-24 13:57:30 -04:00
_data-prepper Add CIDR and User Agent processors (#4585) 2023-07-27 14:58:47 -05:00
_developer-documentation Add extensions documentation (#4202) 2023-07-13 17:59:40 -04:00
_field-types Add partial flat object documentation (#4477) 2023-07-14 17:27:53 -04:00
_im-plugin Add index codec documentation (#4589) 2023-07-21 16:10:18 -04:00
_includes Toc keyboard navigation (#4497) 2023-07-17 10:11:42 -07:00
_install-and-configure Updated tls.md with 2 different CA settings (#4574) 2023-07-20 15:03:05 -05: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 Connectors and ML updates for 2.9 (#4554) 2023-07-19 16:35:46 -07:00
_monitoring-your-cluster Logs wording changes (#4101) 2023-05-17 21:01:58 -04:00
_observing-your-data Fix a link name in documentation (#4617) 2023-07-24 11:16:30 -07:00
_plugins Use a different user-agent. (#4313) 2023-06-13 16:25:08 -04:00
_query-dsl Add geohash, geotile, and geobounds aggregation on geoshapes documentation (#4517) 2023-07-18 10:58:30 -04:00
_sass Toc keyboard navigation (#4497) 2023-07-17 10:11:42 -07:00
_search-plugins Fix links for Personalize documentation (#4641) 2023-07-26 17:37:13 -04:00
_security [DOC] Add missing plugins.security.ssl.http.enabled for PEM paragraph (#4491) 2023-07-20 15:06:59 -05:00
_security-analytics Fix correlation engine documentation by removing all instances of the experimental flag for 2.9 (#4635) 2023-07-25 14:03:50 -07:00
_tools Fixes to redirects (#4195) 2023-05-26 14:48:31 -07:00
_troubleshoot More redirects and spelling fixes (#4093) 2023-05-17 09:57:14 -07:00
_tuning-your-cluster * [DOC] Added 'Search' nodes description in 'Creating a cluster' page (#4597) 2023-07-28 13:15:26 -04:00
_upgrade-to updatestomigrationdoc (#4343) 2023-06-22 09:30:49 -05:00
assets Toc keyboard navigation (#4497) 2023-07-17 10:11:42 -07:00
images Fix correlation engine documentation by removing all instances of the experimental flag for 2.9 (#4635) 2023-07-25 14:03:50 -07: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 Rewrite Contributing and readme (#4416) 2023-07-19 12:36:37 -04:00
Gemfile Upgrade Jekyll to 4.3.2 (#3709) 2023-05-11 12:33:20 -05: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 Add Connectors and ML updates for 2.9 (#4554) 2023-07-19 16:35:46 -07:00
TERMS.md Fix term (#4634) 2023-07-25 15:03:48 -04:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml Add 2.9 version (#4590) 2023-07-24 13:57:30 -04:00
about.md Link fix (#3223) 2023-03-06 11:41:22 -05:00
breaking-changes.md [DOC] Add new cluster metrics monitor supported APIs (#4525) 2023-07-19 14:54:37 -06: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 Change date for the 2.9 release (#4619) 2023-07-24 15:03:59 -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.