本文档是针对 OpenSearch 的简体中文本地化仓库。包括有 OpenSearch 引擎以及相关的一些插件。仓库中的内容是从官方 GitHub 代码库中 Fork 下来后进行编译和修改的。
Go to file
Nathan Bower 20c87bb150
Updates style guide and terms (#3980)
* Updates style guide and terms

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

* Adds term

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

* Adds guidance

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>

---------

Signed-off-by: natebower <102320899+natebower@users.noreply.github.com>
2023-05-04 13:09:26 -04:00
.github Add style workflow (#3909) 2023-05-03 12:34:05 -04:00
_api-reference Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_clients Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_dashboards Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_data Add 2.7 version PR (#3917) 2023-05-02 13:56:18 -04:00
_data-prepper Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_field-types Add flat object field type (#3714) 2023-05-02 11:03:39 -04:00
_im-plugin Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_includes Use the modified dates of files in the sitemap (#3774) 2023-04-14 12:03:52 -04:00
_install-and-configure Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_job-scheduler-plugin Adds documentation for Job Scheduler plugin (#2242) 2023-01-05 08:24:24 -08:00
_layouts Updates site UI changes (#2264) 2022-12-27 11:45:32 -05:00
_ml-commons-plugin Fix ML links (#3976) 2023-05-04 11:17:15 -05:00
_monitoring-your-cluster Add documentation for Shard Hotspot Identification RCA (#3741) 2023-05-02 11:03:11 -04:00
_observing-your-data Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_plugins Add CI with link checker. (#3584) 2023-04-04 15:49:27 -04:00
_query-dsl Index and OpenSearch TOC changes (#2946) 2023-03-08 09:53:21 -06:00
_replication-plugin Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_sass Update segment replication backpressure (#3839) 2023-05-02 10:59:20 -04:00
_search-plugins Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_security Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_security-analytics Add correlation engine to Security Analytics documentation (#3814) 2023-05-02 10:36:27 -07:00
_tools Add CI with link checker. (#3584) 2023-04-04 15:49:27 -04:00
_troubleshoot Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_tuning-your-cluster Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
_upgrade-to Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
assets Split comments into parts (#3082) 2023-02-28 15:18:02 -05:00
images Add correlation engine to Security Analytics documentation (#3814) 2023-05-02 10:36:27 -07:00
release-notes Add 2.7 documentation release notes (#3919) 2023-05-02 14:53:56 -04:00
.gitignore Remove script from gitignore (#3295) 2023-03-08 15:19:34 -05:00
.vale.ini Add style workflow (#3909) 2023-05-03 12:34:05 -04: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 Add Formatting Guide to GitHub (#3097) 2023-03-07 16:57:29 -05:00
FORMATTING_GUIDE.md Add inline icons to formatting guide (#3785) 2023-04-17 12:10:55 -04:00
Gemfile Use the modified dates of files in the sitemap (#3774) 2023-04-14 12:03:52 -04: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 Add style workflow (#3909) 2023-05-03 12:34:05 -04:00
STYLE_API_TEMPLATE.md Update style guide (#2939) 2023-02-16 15:00:47 -05:00
STYLE_GUIDE.md Updates style guide and terms (#3980) 2023-05-04 13:09:26 -04:00
TERMS.md Updates style guide and terms (#3980) 2023-05-04 13:09:26 -04:00
THIRD-PARTY Initial documentation cut 2021-05-05 10:09:47 -07:00
_config.yml Add 2.7 version PR (#3917) 2023-05-02 13:56:18 -04:00
about.md Link fix (#3223) 2023-03-06 11:41:22 -05:00
breaking-changes.md Update to Breaking changes file (#3550) 2023-03-23 12:15:59 -07: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 Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
quickstart.md Correct plugin capitalization (#3838) 2023-05-04 11:11:54 -04:00
version-history.md Fix ML links (#3976) 2023-05-04 11:17:15 -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/).

    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.

Formatting documentation

The OpenSearch documentation uses a modified version of the just-the-docs Jekyll theme. For an overview of the commonly used formatted elements, including callouts, videos, and buttons, see the FORMATTING_GUIDE.

Style linting

We use the Vale linter to ensure that our documentation adheres to the OpenSearch Project Style Guidelines. To install Vale locally, follow these steps:

  1. Run brew install vale.
  2. Run vale * from the documentation site root directory to lint all Markdown files. To lint a specific file, run vale /path/to/file.

Optionally, you can install the Vale VSCode extension that integrates Vale with Visual Studio Code. By default, only errors and warnings are underlined. To change the minimum alert level to include suggestions, go to Vale VSCode > Extension Settings and select suggestion in the Vale > Vale CLI: Min Alert Level dropdown list.

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.