本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
Go to file
Daniel Widdis 93878a9e29
Fix Java client example (#6438)
The syntax provided for the second example at https://opensearch.org/docs/latest/clients/java/#initializing-the-client-with-ssl-and-tls-enabled-using-restclient-transport is invalid:
 - hostname and port order are reversed
 - the password field is a character array

The correct syntax is used earlier on the page for the Apache HTTP client version.

Signed-off-by: Daniel Widdis <widdis@gmail.com>
2024-02-19 12:56:03 -06:00
.github Update javascript client sample program and Vale rules (#6435) 2024-02-19 11:12:07 -05:00
_about Remove admin:admin default and update instructions for demo setup (#5887) 2024-02-01 11:01:58 -08:00
_aggregations Improve terms aggregation documentation and add concurrent segment search caveats (#6355) 2024-02-07 18:47:32 -05:00
_analyzers Add documentation for Normalizers (#6415) 2024-02-15 10:04:47 -05:00
_api-reference Add closed details block to formatting guide (#6421) 2024-02-16 12:32:44 -05:00
_automating-workflows Change math tool to CAT index tool in the workflow tutorial (#6401) 2024-02-14 16:48:58 -05:00
_benchmark Add Running a Workload (#6287) 2024-02-13 14:28:04 -06:00
_clients Fix Java client example (#6438) 2024-02-19 12:56:03 -06:00
_dashboards Add closed details block to formatting guide (#6421) 2024-02-16 12:32:44 -05:00
_data Separate clients, data prepper, and benchmark documentation (#5878) 2024-01-03 15:48:59 -05:00
_data-prepper MAINT: Data Prepper opensearch source metrics (#6392) 2024-02-16 12:08:49 -06:00
_developer-documentation Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_field-types Add documentation for Normalizers (#6415) 2024-02-15 10:04:47 -05:00
_im-plugin [DOC] Support switch_aliases in shrink action. (#5511) 2024-02-01 11:03:38 -08:00
_includes Refactor home page layout (#6307) 2024-01-31 11:54:59 -05:00
_ingest-pipelines Add copy ingest processor (#6294) 2024-02-05 12:19:23 -08:00
_install-and-configure Add documentation for Normalizers (#6415) 2024-02-15 10:04:47 -05:00
_integrations Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_layouts Refactor home page layout (#6307) 2024-01-31 11:54:59 -05:00
_ml-commons-plugin Add cross-encoder model documentation (#6357) 2024-02-16 08:44:29 -05:00
_monitoring-your-cluster Adds metrics framework documentation (#6393) 2024-02-15 12:01:25 -06:00
_observing-your-data Update casing for top N queries (#6431) 2024-02-16 18:41:56 -05:00
_plugins Fix link in concurrent segment search (#6436) 2024-02-19 11:56:44 -05:00
_query-dsl Update javascript client sample program and Vale rules (#6435) 2024-02-19 11:12:07 -05:00
_reporting Remove admin:admin default and update instructions for demo setup (#5887) 2024-02-01 11:01:58 -08:00
_sass Add flow framework documentation (#6257) 2024-02-07 18:44:49 -05:00
_search-plugins Fix link in concurrent segment search (#6436) 2024-02-19 11:56:44 -05:00
_security Add closed details block to formatting guide (#6421) 2024-02-16 12:32:44 -05:00
_security-analytics Add threat intelligence for 2.12 (#6273) 2024-02-08 14:19:47 -06:00
_tools Add link to OpenSearch FAQ (#6412) 2024-02-15 09:13:56 -05:00
_troubleshoot Remove admin:admin default and update instructions for demo setup (#5887) 2024-02-01 11:01:58 -08:00
_tuning-your-cluster Add closed details block to formatting guide (#6421) 2024-02-16 12:32:44 -05:00
_upgrade-to Remove admin:admin default and update instructions for demo setup (#5887) 2024-02-01 11:01:58 -08:00
assets Adds documentation for security demo configuration setup (#6058) 2024-02-01 10:00:23 -08:00
images Update image in the workflow tutorial (#6414) 2024-02-15 10:19:44 -05: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 Remove adverbs of time rule (#6323) 2024-01-31 12:13:35 -05: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 Clarify that you are install bundler, and bundler takes care of jekyll (#6286) 2024-01-29 14:33:20 -05:00
FORMATTING_GUIDE.md Add closed details block to formatting guide (#6421) 2024-02-16 12:32:44 -05: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 Update MAINTAINERS.md (#6066) 2024-01-08 16:22:21 -08: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 Remove two sentences from style guide (#6322) 2024-01-31 12:10:26 -05:00
TERMS.md Change keystore in terms (#6329) 2024-02-01 09:40:23 -05:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml Add flow framework documentation (#6257) 2024-02-07 18:44:49 -05: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 Separate clients, data prepper, and benchmark documentation (#5878) 2024-01-03 15:48:59 -05: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.