本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
Go to file
Alice Williams a41457242e
for acronym spell out 1st instance (#2232)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-12-15 09:36:09 -08:00
.github Removes the local DCO action, adds a custom PR template, configures the inherited DCO action (#1317) 2022-09-26 17:41:45 -07:00
_api-reference Correct API endpoints for CAT API reference (#2158) 2022-12-13 09:52:53 -08:00
_clients Add opensearch-py-ml title (#2149) 2022-12-07 13:20:36 -06:00
_dashboards Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
_data Adds 2.4.0 version (#1885) 2022-11-15 16:44:21 -05:00
_data-prepper Editorial feedback for Expression syntax (#2168) 2022-12-12 16:17:06 -07:00
_external_links Update external link to Dashboards developer guide 2021-08-27 12:46:55 -07:00
_im-plugin Adds documentation for ISM error prevention (#2090) 2022-12-06 13:49:26 -08:00
_includes Adds documentation site changes (sticky nav, copy button, back to top button) (#2043) 2022-12-02 12:03:46 -05:00
_install-and-configure Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
_layouts Removes feedback buttons (#2169) 2022-12-14 15:20:17 -05:00
_ml-commons-plugin Fix Neural search pipeline example (#2177) 2022-12-13 15:33:01 -06:00
_monitoring-plugins for acronym spell out 1st instance (#2232) 2022-12-15 09:36:09 -08:00
_neural-search-plugin Fix Neural search pipeline example (#2177) 2022-12-13 15:33:01 -06:00
_notifications-plugin Puts column headers in sentence case (#1989) 2022-11-18 15:25:06 -05:00
_observability-plugin Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
_opensearch Adds geo-bounding box query documentation (#2134) 2022-12-07 11:07:04 -05:00
_plugins Improve logging of the link checker (#1252) 2022-09-19 11:55:18 -07:00
_replication-plugin Merge pull request #559 from opensearch-project/ccr-fix 2022-05-24 09:43:32 -05:00
_sass Removes feedback buttons (#2169) 2022-12-14 15:20:17 -05:00
_search-plugins Changes section heading in search relevance (#2052) 2022-11-28 14:11:35 -05:00
_security-analytics Update index.md (#2081) 2022-12-01 14:36:45 -08:00
_security-plugin Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
_tools Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
_troubleshoot Revert SAML troubleshooting page to _opendistro route to match existing route (#2160) 2022-12-08 17:13:36 -08:00
_upgrade-to cluster.initial_master_nodes is no longer present in the documentation. It was replaced with cluster.initial_cluster_manager_nodes. (#2020) 2022-11-23 15:59:15 -06:00
assets Adds documentation site changes (sticky nav, copy button, back to top button) (#2043) 2022-12-02 12:03:46 -05:00
images Add Log analytics to doc website repo (#1977) 2022-12-09 10:03:35 -07:00
release-notes Update opensearch-documentation-release-notes-2.4.0.md (#1890) 2022-11-15 13:54:34 -06:00
.gitignore Add SSL configuration for Dashboards 2021-07-09 15:33:35 -07:00
404.md Initial documentation cut 2021-05-05 10:09:47 -07: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 Updated contribution.md file with DCO info & updated process (#689) 2022-06-22 12:43:07 -05:00
Gemfile Add home page and experimental features section (#1146) 2022-09-14 12:27:15 -05:00
LICENSE Initial commit 2021-05-03 10:11:12 -07:00
MAINTAINERS.md Rename maintainers.md to MAINTAINERS.md (#1797) 2022-11-03 11:44:47 -05:00
NOTICE Remove year from copyright 2021-08-09 15:53:52 -07:00
README.md Update Points of Contact on readme (#2192) 2022-12-13 14:44:46 -06:00
STYLE_API_TEMPLATE.md Puts column headers in sentence case (#1989) 2022-11-18 15:25:06 -05:00
STYLE_GUIDE.md Updates-TERMS.md (#2076) 2022-12-01 08:50:50 -05:00
TERMS.md Updates-TERMS.md (#2076) 2022-12-01 08:50:50 -05:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
about.md Create OpenSearch documentation main section (#2080) 2022-12-01 16:25:02 -06:00
breaking-changes.md Create OpenSearch documentation main section (#2080) 2022-12-01 16:25:02 -06:00
build.sh Changed from 644 to 755 perm (#1441) 2022-10-05 10:29:28 -07:00
check-links.sh No more relative links 2021-06-09 19:15:41 -07: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 Create OpenSearch documentation main section (#2080) 2022-12-01 16:25:02 -06:00
quickstart.md Add installation and configuration section (#2130) 2022-12-05 14:13:41 -06:00
version-history.md Adds 1.3.7 and 2.4.1 to version history (#2188) 2022-12-13 16:19:17 -05:00

README.md

About the OpenSearch documentation repo

The documentation repository contains the documentation for OpenSearch, the search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. You can find the rendered documentation at opensearch.org/docs.

How you can help

Community contributions remain essential in keeping this documentation comprehensive, useful, well-organized, and up-to-date. If you are interested in contributing, please see the Contribution file.

Points of contact

If you encounter problems or have questions when contributing to the documentation, these people can help:

How the website works

This repository contains Markdown files organized into Jekyll "collections" (e.g., _search-plugins, _opensearch, etc.). Each Markdown file correlates with one page on the website.

Using plain text on GitHub has many advantages:

  • Everything is free, open source, and works on every operating system. Use your favorite text editor, Ruby, Jekyll, and Git.
  • Markdown is easy to learn and looks good in side-by-side diffs.
  • The workflow is no different than contributing code. Make your changes, build locally to check your work, and submit a pull request. Reviewers check the PR before merging.
  • Alternatives like wikis and WordPress are full web applications that require databases and ongoing maintenance. They also have inferior versioning and content review processes compared to Git. Static websites, such as the ones Jekyll produces, are faster, more secure, and more stable.

In addition to the content for a given page, each Markdown file contains some Jekyll front matter. Front matter looks like this:

---
layout: default
title: Alerting security
nav_order: 10
parent: Alerting
has_children: false
---

If you want to reorganize content or add new pages, keep an eye on has_children, parent, and nav_order, which define the hierarchy and order of pages in the lefthand navigation. For more information, see the documentation for our upstream Jekyll theme.

Contribute content

There are a few ways to contribute content, depending on the magnitude of the change.

Minor changes

If you want to add a few paragraphs across multiple files and are comfortable with Git, try this approach:

  1. Fork this repository.

  2. Download GitHub Desktop, install it, and clone your fork.

  3. Navigate to the repository root.

  4. Create a new branch.

  5. Edit the Markdown files in /docs.

  6. Commit, sign off, push your changes to your fork, and submit a pull request.

Major changes

If you're making major changes to the documentation and need to see the rendered HTML before submitting a pull request, here's how to make the changes and view them locally:

  1. Fork this repository.

  2. Download GitHub Desktop, install it, and clone your fork.

  3. Navigate to the repository root.

  4. Install Ruby if you don't already have it. We recommend RVM, but use whatever method you prefer:

    curl -sSL https://get.rvm.io | bash -s stable
    rvm install 2.6
    ruby -v
    
  5. Install Jekyll if you don't already have it:

    gem install bundler jekyll
    
  6. Install dependencies:

    bundle install
    
  7. Build:

    sh build.sh    
    
  8. If the build script doesn't automatically open your web browser (it should), open http://localhost:4000/docs/.

  9. Create a new branch.

  10. Edit the Markdown files in each collection (e.g. _security-plugin/).

    If you're a web developer, you can customize _layouts/default.html and _sass/custom/custom.scss.

  11. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10-30 seconds.

  12. When you're happy with how everything looks, commit, sign off, push your changes to your fork, and submit a pull request.

Writing tips

The OpenSearch team released style guidelines for our documentation and marketing content. These guidelines cover the style standards and terms to be observed when creating OpenSearch content. We ask that you please adhere to these guidelines whenever contributing content.

We also provide guidelines on terminology. For a list of OpenSearch terms, see Terms.

Classes within Markdown

This documentation uses a modified version of the just-the-docs Jekyll theme, which has some useful classes for labels and buttons:

[Get started](#get-started){: .btn .btn-blue }

## Get started
New
{: .label .label-green }
  • Labels come in default (blue), green, purple, yellow, and red.
  • Buttons come in default, purple, blue, green, and outline.
  • Warning, tip, and note blocks are available ({: .warning }, etc.).
  • If an image has a white background, you can use {: .img-border } to add a one pixel border to the image.

These classes can help with readability, but should be used sparingly. Each addition of a class damages the portability of the Markdown files and makes moving to a different Jekyll theme (or a different static site generator) more difficult.

Besides, standard Markdown elements suffice for most documentation.

Labels for APIs

Each API operation has a label indicating when it was introduced. For most operations, this label is 1.0:

## Get roles
Introduced 1.0
{: .label .label-purple }

If we introduce a breaking change to an operation, add an additional label with a link to the release note for that breaking change:

## Get roles
Introduced 1.0
{: .label .label-purple }
[Last breaking change 2.0](https://example.com)
{: .label .label-red }

Math

If you want to use the sorts of pretty formulas that MathJax allows, add has_math: true to the Jekyll page metadata. Then insert LaTeX math into HTML tags with the rest of your Markdown content:

## Math

Some Markdown paragraph. Here's a formula:

<p>
  When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are
  \[x = {-b \pm \sqrt{b^2-4ac} \over 2a}.\]
</p>

And back to Markdown.

Code of conduct

This project has adopted an Open Source Code of Conduct.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

Copyright OpenSearch contributors.