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,602 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
Eric Pugh a35b5cfb97
Clarify that you are install bundler, and bundler takes care of jekyll (#6286) 
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
 		2024-01-29 14:33:20 -05:00
.github Fix Jekyll build workflow Ruby Version (#6281) 2024-01-29 12:36:29 -06:00
_about Add version to the OpenSearch documentation section (#6162) 2024-01-16 20:28:46 -05:00
_aggregations Add max_docs_per_value to diversified sampler documentation (#6134) 2024-01-26 09:09:49 -07:00
_analyzers Update index.md (#6223) 2024-01-18 16:29:20 -05:00
_api-reference [DOC] Added documentation for admission control stats (#6253) 2024-01-26 09:09:35 -05:00
_benchmark Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_clients Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_dashboards Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_data Separate clients, data prepper, and benchmark documentation (#5878) 2024-01-03 15:48:59 -05:00
_data-prepper Add log enrichment use case to Data Prepper (#6225) 2024-01-22 13:15:47 -07:00
_developer-documentation Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_field-types Update knn-vector.md (#6263) 2024-01-26 11:40:39 -05:00
_im-plugin Point all non-versioned documentation to latest and add permalinks (#6042) 2024-01-05 08:58:23 -05:00
_includes Point all non-versioned documentation to latest and add permalinks (#6042) 2024-01-05 08:58:23 -05:00
_ingest-pipelines Fix link (#6280) 2024-01-29 11:20:23 -07:00
_install-and-configure Update bundled JDK version (January 2024 Patch releases) (#6250) 2024-01-29 11:35:51 -06:00
_integrations Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_layouts Add shadow to version selector panel when left nav is scrolled (#6151) 2024-01-16 13:11:25 -05:00
_ml-commons-plugin Fix link to all-MiniLM-L12-v2 Torch model config - use Torch config file rather than ONNX (#6227) 2024-01-19 10:11:13 -05:00
_monitoring-your-cluster Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_observing-your-data Rename collection links to directory names (#6040) 2024-01-04 18:59:53 -05:00
_plugins Update link checker (#5708) 2023-11-30 13:44:59 -05:00
_query-dsl Update neural search documentation to include filters (#6254) 2024-01-24 16:48:23 -05:00
_reporting Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_sass Change list style and font size for right TOC (#6208) 2024-01-18 13:15:21 -05:00
_search-plugins Correct heading level for approximate k-NN (#6239) 2024-01-22 15:45:32 -05:00
_security Fix field masking examples (#6193) 2024-01-22 17:00:17 -05:00
_security-analytics Correct SA findings alerts API (#6179) 2024-01-16 18:01:55 -06:00
_tools Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_troubleshoot Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
_tuning-your-cluster [Doc] Add documentation for .replication-metadata-index for cross-cluster-replication. (#6082) 2024-01-16 11:16:02 -06:00
_upgrade-to Change navigation for index pages of collections (#6039) 2024-01-04 14:55:05 -05:00
assets Add version to the OpenSearch documentation section (#6162) 2024-01-16 20:28:46 -05:00
images Fix ism policy image (#6020) 2024-01-03 09:34:28 -07: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 Ignore camel case in heading capitalization, add double slash and double parentheses rules to Vale (#6165) 2024-01-16 12:55:47 -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 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 (#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 AWS Style Guide (#5762) 2023-12-01 14:05:59 -05:00
TERMS.md Add trade-off and ingest pipeline to terms (#6100) 2024-01-09 12:05:53 -05:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml Update _config.yml (#6161) 2024-01-16 12:35:45 -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

Copyright OpenSearch contributors.