2021-05-05 13:09:47 -04:00
title : OpenSearch documentation
description : >- # this means to ignore newlines until "baseurl:"
Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
2021-10-29 13:22:04 -04:00
# baseurl: "/docs/latest" # the subpath of your site, e.g. /blog
baseurl : ""
2021-10-28 14:53:18 -04:00
url : "https://opensearch.ossez.com" # the base hostname & protocol for your site, e.g. http://example.com
2021-06-10 16:44:37 -04:00
permalink : /:path/
2021-05-05 13:09:47 -04:00
2021-09-30 16:43:24 -04:00
opensearch_version : 1.1 .0
opensearch_major_minor_version : 1.1
lucene_version : 8_9_0
2021-05-05 13:09:47 -04:00
# Build settings
markdown : kramdown
remote_theme : pmarsceill/just-the-docs@v0.3.3
# Kramdown settings
kramdown :
toc_levels : 2 ..3
2021-05-07 12:57:01 -04:00
logo : "/assets/images/logo.svg"
2021-05-05 13:09:47 -04:00
# Aux links for the upper right navigation
aux_links :
2021-07-08 12:27:17 -04:00
2021-05-05 13:09:47 -04:00
color_scheme : opensearch
2021-05-28 13:48:19 -04:00
# Define Jekyll collections
collections :
# Define a collection named "tests", its documents reside in the "_tests" directory
2021-06-15 16:54:44 -04:00
upgrade-to :
2021-06-11 14:12:32 -04:00
permalink : /:collection/:path/
output : true
2021-05-28 14:19:18 -04:00
opensearch :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 13:48:19 -04:00
output : true
2021-05-28 14:19:18 -04:00
dashboards :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 13:48:19 -04:00
output : true
2021-05-28 15:43:12 -04:00
security-plugin :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 15:43:12 -04:00
output : true
search-plugins :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 15:43:12 -04:00
output : true
im-plugin :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 15:43:12 -04:00
output : true
2021-09-30 19:10:28 -04:00
replication-plugin :
permalink : /:collection/:path/
output : true
2021-05-28 15:43:12 -04:00
monitoring-plugins :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 14:19:18 -04:00
output : true
clients :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 14:19:18 -04:00
output : true
troubleshoot :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 13:48:19 -04:00
output : true
external_links :
2021-06-10 17:42:36 -04:00
permalink : /:collection/:path/
2021-05-28 13:48:19 -04:00
output : true
just_the_docs :
# Define the collections used in the theme
collections :
2021-06-15 16:54:44 -04:00
upgrade-to :
name : Upgrade to OpenSearch
2021-05-28 13:48:19 -04:00
# nav_exclude: true
2021-05-28 14:19:18 -04:00
nav_fold : true
2021-05-28 13:48:19 -04:00
# search_exclude: true
2021-06-11 14:12:32 -04:00
opensearch :
name : OpenSearch
nav_fold : true
2021-05-28 14:19:18 -04:00
dashboards :
2021-05-28 13:48:19 -04:00
name : OpenSearch Dashboards
2021-05-28 14:19:18 -04:00
nav_fold : true
2021-05-28 15:43:12 -04:00
security-plugin :
name : Security plugin
nav_fold : true
search-plugins :
name : Search plugins
nav_fold : true
im-plugin :
name : Index management plugin
nav_fold : true
2021-09-30 19:10:28 -04:00
replication-plugin :
name : Replication plugin
nav_fold : true
2021-05-28 15:43:12 -04:00
monitoring-plugins :
name : Monitoring plugins
2021-05-28 14:19:18 -04:00
nav_fold : true
clients :
2021-06-10 12:09:20 -04:00
name : Clients and tools
2021-05-28 14:19:18 -04:00
nav_fold : true
troubleshoot :
2021-05-28 13:48:19 -04:00
name : Troubleshooting
2021-05-28 14:19:18 -04:00
nav_fold : true
2021-05-28 13:48:19 -04:00
external_links :
name : External links
2021-05-05 13:09:47 -04:00
# Enable or disable the site search
# Supports true (default) or false
search_enabled : true
search :
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level : 2
# Maximum amount of previews per search result
# Default: 3
previews : 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before : 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after : 10
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator : /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url : true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button : false
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
2021-10-29 14:42:48 -04:00
ga_tracking : GTM-W3NL9V
2021-05-05 13:09:47 -04:00
# Disable the just-the-docs theme anchor links in favor of our custom ones
# See _includes/head_custom.html
heading_anchors : false
# Adds on-hover anchor links to h2-h6
anchor_links : true
footer_content :
plugins :
- jekyll-remote-theme
- jekyll-redirect-from
2021-08-04 14:50:26 -04:00
- jekyll-sitemap
2021-05-05 13:09:47 -04:00
# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
exclude :
- Gemfile
- Gemfile.lock
- node_modules
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- README.md