Skip to content

Commit

Permalink
Merge branch 'main' into Johnh_dfm_overrides_all
Browse files Browse the repository at this point in the history
  • Loading branch information
leanneeliatra authored Feb 21, 2024
2 parents cfaeea3 + 1760757 commit 942f97f
Show file tree
Hide file tree
Showing 482 changed files with 26,071 additions and 7,303 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @cwillum @hdhalter @kolchfa-aws @Naarcha-AWS @vagimeli @ananzh @seanneumann @AMoo-Miki @natebower
* @hdhalter @kolchfa-aws @Naarcha-AWS @vagimeli @AMoo-Miki @natebower @dlvenable
8 changes: 0 additions & 8 deletions .github/vale/styles/OpenSearch/AdverbsOfTime.yml

This file was deleted.

7 changes: 5 additions & 2 deletions .github/vale/styles/OpenSearch/HeadingCapitalization.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ message: "'%s' is a heading and should be in sentence case."
level: error
scope: heading
match: $sentence
threshold: 1
indicators:
- ":"
- "."
- ")"
exceptions:
- k # ignores lowercase k-NN
- k # ignores lowercase k-NN
- '[A-Z]{2,}' # ignores all acronyms
- '([A-Z][a-z0-9]+){2,}' # ignores all camel case words
8 changes: 8 additions & 0 deletions .github/vale/styles/OpenSearch/LinksDoubleParentheses.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: existence
message: "Remove double parentheses from the link '%s'."
level: error
nonword: true
scope: raw
tokens:
- '\]\({2,}[^)]*?\){1,}'

7 changes: 7 additions & 0 deletions .github/vale/styles/OpenSearch/LinksDoubleSlash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Remove double slashes from the link '%s'."
level: error
nonword: true
scope: raw
tokens:
- '\(\{\{site.url\}\}\{\{site.baseurl\}\}[^)]*?\/{2,}[^)]*?\)'
7 changes: 5 additions & 2 deletions .github/vale/styles/OpenSearch/SubstitutionsError.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ swap:
'host name': hostname
'Huggingface': Hugging Face
'indices': indexes
'keystore': key store
'ingestion pipeline': ingest pipeline
'key store': keystore
'key/value': key-value
'kmeans': k-means
'kNN': k-NN
'machine-learning': machine learning
Expand All @@ -44,7 +46,8 @@ swap:
'time series data': time-series data
'time stamp': timestamp
'timezone': time zone
'truststore': trust store
'tradeoff': trade-off
'trust store': truststore
'U.S.': US
'web page': webpage
'web site': website
Expand Down
3 changes: 3 additions & 0 deletions .github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Anomaly Detection plugin
Asynchronous Search plugin
Crypto plugin
Cross-Cluster Replication plugin
Custom Codecs plugin
Flow Framework plugin
Maps plugin
Notebooks plugin
Notifications plugin
Expand All @@ -18,6 +20,7 @@ ML Commons plugin
Neural Search plugin
Observability plugin
Performance Analyzer plugin
Query Insights plugin
Query Workbench plugin
Search Relevance plugin
Security plugin
Expand Down
10 changes: 10 additions & 0 deletions .github/vale/styles/Vocab/OpenSearch/Products/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Adoptium
Amazon
Amazon OpenSearch Serverless
Amazon OpenSearch Service
Amazon Bedrock
Amazon SageMaker
Ansible
Auditbeat
AWS Cloud
Expand All @@ -27,6 +29,7 @@ Fluent Bit
Fluentd
Helm
Hugging Face
IdP
Inferentia
IP2Geo
IPv4
Expand All @@ -36,6 +39,7 @@ JavaScript
Jaeger
Jaeger HotROD
JSON
JSON Web Token
Keycloak
Kerberos
Kibana
Expand All @@ -52,10 +56,14 @@ Minikube
Nagios
Okta
Open Distro
OpenAI
OpenID Connect
OpenSearch
OpenSearch Assistant
OpenSearch Assistant Toolkit
OpenSearch Benchmark
OpenSearch Dashboards
OpenSearch Playground
OpenSearch Project
OpenSearch Service
OpenSSL
Expand All @@ -73,6 +81,7 @@ Python
PyTorch
Querqy
Query Workbench
RCF Summarize
RPM Package Manager
Ruby
Simple Schema for Observability
Expand All @@ -81,3 +90,4 @@ TorchScript
Tribuo
VisBuilder
Winlogbeat
Zstandard
11 changes: 11 additions & 0 deletions .github/vale/styles/Vocab/OpenSearch/Words/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
[Bb]igram
Boolean
[Cc]allout
[Cc]hatbots?
[Cc]odec
[Cc]omposable
[Cc]onfig
Expand All @@ -17,7 +18,9 @@ Boolean
[Dd]ashboarding
[Dd]atagram
[Dd]eallocate
[Dd]eduplicates?
[Dd]eduplication
[Dd]eprovision(s|ed|ing)?
[Dd]eserialize
[Dd]eserialization
Dev
Expand Down Expand Up @@ -62,6 +65,7 @@ Levenshtein
[Ll]ossy
[Ll]owercases?d?
[Mm]acrobenchmarks?
[Mm]etaphone
[Mm]isorder
[Mm]ultifield
[Mm]ultiline
Expand All @@ -70,8 +74,11 @@ Levenshtein
[Mm]ultipolygon
[Mm]ultithreaded
[Mm]ultivalued
[Mm]ultiword
[Nn]amespace
[Oo]versamples?
pebibyte
[Pp]erformant
[Pp]luggable
[Pp]reconfigure
[Pp]refetch
Expand Down Expand Up @@ -99,7 +106,9 @@ pebibyte
[Ss]erverless
[Ss]harding
[Ss]ignificand
[Ss]napshott(ed|ing)
stdout
[Ss]temmers?
[Ss]ubaggregation
[Ss]ubcalculation
[Ss]ubcollectors?
Expand All @@ -110,6 +119,7 @@ stdout
[Ss]ubtag
[Ss]ubtree
[Ss]ubvector
[Ss]ubwords?
[Ss]uperset
tebibyte
[Tt]emplated
Expand All @@ -124,6 +134,7 @@ tebibyte
[Uu]nigram
[Uu]nnesting
[Uu]nrecovered
[Uu]nregister(s|ed|ing)?
[Uu]pdatable
[Uu]psert
[Ww]alkthrough
Expand Down
4 changes: 4 additions & 0 deletions .github/vale/tests/test-headings.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@

---

# 1. This should not be flagged

---

# Example: should be flagged

---
Expand Down
6 changes: 4 additions & 2 deletions .github/vale/tests/test-style-neg.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

This sentence tests Advanced Placement (AP). We should define AP before using.

Then this sentence tests adverbs of time.

This sentence tests cybersecurity.

This sentence tests dash---spacing.
Expand Down Expand Up @@ -32,6 +30,10 @@ This sentence tests Latin substitution through using Latin.

## This heading: Tests colons but fails capitalization

This sentence tests [links double parentheses]({{site.url}}{{site.baseurl}}/opensearch/).

This sentence tests [links double slash]({{site.url}}{{site.baseurl}}/opensearch/).

This sentence tests [links end slash]({{site.url}}{{site.baseurl}}/opensearch/).

This sentence tests [links mid slash]({{site.url}}{{site.baseurl}}/opensearch/).
Expand Down
6 changes: 4 additions & 2 deletions .github/vale/tests/test-style-pos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

This sentence tests AP. AP should be defined before using.

Then, this sentence tests adverbs of time.

This sentence tests cyber security.

This sentence tests dash --- spacing.
Expand Down Expand Up @@ -32,6 +30,10 @@ This sentence tests Latin substitution via using Latin.

## This heading: tests colons

This sentence tests [links double parentheses](({{site.url}}{{site.baseurl}}/opensearch/)).

This sentence tests [links double slash]({{site.url}}{{site.baseurl}}/opensearch//double-slash/).

This sentence tests [links end slash]({{site.url}}{{site.baseurl}}/opensearch).

This sentence tests [links mid slash]({{site.url}}{{site.baseurl}}opensearch).
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/jekyll-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
- uses: actions/checkout@v3
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0'
ruby-version: '3.2'
bundler-cache: true
- run: |
JEKYLL_FATAL_LINK_CHECKER=internal bundle exec jekyll build --future
3 changes: 2 additions & 1 deletion .github/workflows/vale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ jobs:
fail_on_error: false
reporter: github-pr-check
filter_mode: added
vale_flags: "--no-exit"
vale_flags: "--no-exit"
version: 2.28.0
3 changes: 2 additions & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Vale.Spelling = NO
Vale.Repetition = NO
Vale.Terms = YES
OpenSearch.AcronymParentheses = YES
OpenSearch.AdverbsOfTime = YES
OpenSearch.Ampersand = YES
OpenSearch.Cyber = YES
OpenSearch.DashSpacing = YES
Expand All @@ -36,6 +35,8 @@ OpenSearch.HeadingPunctuation = YES
OpenSearch.Inclusive = YES
OpenSearch.LatinismsElimination = YES
OpenSearch.LatinismsSubstitution = YES
OpenSearch.LinksDoubleParentheses = YES
OpenSearch.LinksDoubleSlash = YES
OpenSearch.LinksEndSlash = YES
OpenSearch.LinksMidSlash = YES
OpenSearch.LoginNoun = YES
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,17 @@ Follow these steps to set up your local copy of the repository:

```
curl -sSL https://get.rvm.io | bash -s stable
rvm install 2.7
rvm install 3.2
ruby -v
```

1. Install [Jekyll](https://jekyllrb.com/) if you don't already have it:
1. Install [Bundler](https://bundler.io/) if you don't already have it:

```
gem install bundler jekyll
gem install bundler
```

1. Install the Jekyll dependencies:
1. Install Jekyll and all the dependencies:

```
bundle install
Expand Down Expand Up @@ -141,4 +141,4 @@ Optionally, you can install the [Vale VSCode](https://github.com/chrischinchilla

## Getting help

For help with the contribution process, reach out to one of the [points of contact](README.md#points-of-contact).
For help with the contribution process, reach out to one of the [points of contact](README.md#points-of-contact).
23 changes: 22 additions & 1 deletion FORMATTING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For a callout with multiple paragraphs or lists, use `>`:

## Collapsible blocks

To insert a collapsible block, use the `<details>` element as follows:
To insert an open collapsible block, use the `<details>` element as follows:

````html
<details open markdown="block">
Expand All @@ -132,6 +132,27 @@ To insert a collapsible block, use the `<details>` element as follows:
</details>
````

To insert a closed collapsible block, omit the `open` state:

````html
<details markdown="block">
<summary>
Response
</summary>
{: .text-delta}

```json
{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
}
}
```
</details>
````

Collapsible blocks are useful for long responses and for the Table of Contents at the beginning of a page.

## Dashes
Expand Down
4 changes: 1 addition & 3 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ This document contains a list of maintainers in this repo. See [opensearch-proje

| Maintainer | GitHub ID | Affiliation |
| ---------------- | ----------------------------------------------- | ----------- |
| Chris Moore | [cwillum] (https://github.com/cwillum) | Amazon |
| Heather Halter | [hdhalter](https://github.com/hdhalter) | Amazon |
| Fanit Kolchina | [kolchfa-aws](https://github.com/kolchfa-aws) | Amazon |
| Nate Archer | [Naarcha-AWS](https://github.com/Naarcha-AWS) | Amazon |
| Nate Bower | [natebower](https://github.com/natebower) | Amazon |
| Melissa Vagi | [vagimeli](https://github.com/vagimeli) | Amazon |
| Anan Zhuang | [ananzh](https://github.com/ananzh) | Amazon |
| Sean Neumann | [seanneumann](https://github.com/seanneumann) | Amazon |
| Miki Barahmand | [AMoo-Miki](https://github.com/AMoo-Miki) | Amazon |
| David Venable | [dlvenable](https://github.com/dlvenable) | Amazon |
Loading

0 comments on commit 942f97f

Please sign in to comment.