iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
2,532 Commits 41 Branches 2 Tags 195 MiB
HTML 33%
SCSS 31.8%
CSS 13.9%
JavaScript 12.5%
Ruby 5.3%
Other 3.5%
Go to file
Stephen Crawford 7d8a6a379d
Update JWT documentation to recommend only using jwt_header or audit logging not both (#5914) 
* readd auth token doc

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

* Fix vale

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

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Fix embedded command

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

* Blank lines after headings

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

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* change

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

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Style guidelines

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

* Update _security/access-control/authentication-tokens.md

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* Update _security/access-control/authentication-tokens.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

* warn about audit logging of custom headers

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

* Update _security/authentication-backends/jwt.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Stephen Crawford <65832608+scrawfor99@users.noreply.github.com>

---------

Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Signed-off-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>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
 		2023-12-21 16:16:23 -06:00
.github Update CODEOWNERS (#5920) 2023-12-20 10:33:29 -08: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 Fixes the label on cluster API index page (#5861) 2023-12-12 15:51:08 -05:00
_benchmark Add operations and schedule sections (#5809) 2023-12-20 12:35:58 -06:00
_clients docs: example aws lambda code to initialize client (#5203) 2023-12-20 13:10:58 -05:00
_dashboards Add DQL guide (#5684) 2023-12-12 12:17:19 -05:00
_data Redesigned header / footer integration copied from project site. (#5702) 2023-12-12 15:59:47 -08:00
_data-prepper Added documentation for grok_when option (#5912) 2023-12-21 13:39:11 -07:00
_developer-documentation Add extensions documentation (#4202) 2023-07-13 17:59:40 -04:00
_field-types Fix default doc values for keyword field type (#5924) 2023-12-20 13:32:19 -05:00
_im-plugin Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_includes Updates navigation header background color (#5880) 2023-12-15 20:44:48 -08:00
_ingest-pipelines Update remove ingest processor documentation for some metadata fields are not allowed to remove (#5870) 2023-12-19 13:05:16 -07:00
_install-and-configure update: add wsl commands to set the `vm.max_map_count` (#5077) 2023-12-15 13:45:44 -07:00
_integrations [DOC] Add Integrations new documentation (#4546) 2023-07-19 11:49:32 -06:00
_layouts Redesigned header / footer integration copied from project site. (#5702) 2023-12-12 15:59:47 -08:00
_ml-commons-plugin docs: update type of `version` in model register (#5907) 2023-12-18 12:09:27 -05:00
_monitoring-your-cluster Add documentation for config file settings (#4058) 2023-11-16 16:33:15 -05:00
_observing-your-data Fix the wrong formula to calculate the total number of unique entities supported in the anomaly detection plugin (#4474) 2023-12-21 14:17:49 -07:00
_plugins Update link checker (#5708) 2023-11-30 13:44:59 -05:00
_query-dsl Add DQL guide (#5684) 2023-12-12 12:17:19 -05:00
_reporting [DOC] Move Reporting to high-level section in nav menu (#4654) 2023-07-31 10:13:35 -06:00
_sass Updates navigation header background color (#5880) 2023-12-15 20:44:48 -08:00
_search-plugins Fix search phase result processor intro sentence (#5888) 2023-12-15 15:37:06 -05:00
_security Update JWT documentation to recommend only using jwt_header or audit logging not both (#5914) 2023-12-21 16:16:23 -06:00
_security-analytics Fix Get Mappings example (#5670) 2023-11-30 12:33:42 -06:00
_tools Fixing OpenSearch operator helm install (#5865) 2023-12-14 17:05:02 -08:00
_troubleshoot More redirects and spelling fixes (#4093) 2023-05-17 09:57:14 -07:00
_tuning-your-cluster Update default setting (#5864) 2023-12-12 16:41:33 -07:00
_upgrade-to Add Migrations - Capture and Replay release documentation (#4991) 2023-09-12 14:17:32 -05:00
assets Redesigned header / footer integration copied from project site. (#5702) 2023-12-12 15:59:47 -08:00
images Add DQL guide (#5684) 2023-12-12 12:17:19 -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 Add processor to processor names and links to further info (#5786) 2023-12-05 14:49:46 -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 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 Update MAINTAINERS.md (#5917) 2023-12-20 09:30:12 -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 AWS Style Guide (#5762) 2023-12-01 14:05:59 -05:00
TERMS.md Revises index, indexes (#5784) 2023-12-05 11:01:41 -05: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 Fix heading in the about page (#5919) 2023-12-20 12:36:04 -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 1.3.14 to version history (#5844) 2023-12-12 14:47:55 -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

Copyright OpenSearch contributors.