From c626b999d157cac67c8966d02692e9fb6e309775 Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 13:19:05 -0700 Subject: [PATCH 1/7] Updating README and fixing some syntax suggestions in the blog guide to take out some outdated suggestions. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 3 +++ README.md | 72 ++++----------------------------------------------- 2 files changed, 8 insertions(+), 67 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index 5d0f0cb4cc..d7b0c315dc 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -81,11 +81,14 @@ If you want to specify the image width or another style, use HTML syntax: Similar vectors ``` +~~ To center a Markdown image, specify the `img-centered` class for the image: ``` ![Similar vectors](/assets/media/blog-images/2023-02-13-semantic-search-solutions/vectors.jpg){:class="img-centered"} ``` +~~ +^ The markdown convention that Jekyll uses for adding CSS classes causes issues with our publishing process. Please refrain from using it. Use the raw HTML methodology below. To center an HTML image, include `class="centered"` in the image tag: diff --git a/README.md b/README.md index af56688110..0ae4135be8 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,14 @@ -- [OpenSearch.org website](#opensearchorg-website) - - [Getting help](#getting-help) - - [Contributing](#contributing) - - [Adding to the Partners page](#adding-to-the-partners-page) - - [Writing a blog](#writing-a-blog) - - [Building the website](#building-the-website) - - [Testing](#testing) - - [Link checker](#link-checker) - - [Code of Conduct](#code-of-conduct) - - [Security](#security) - - [License](#license) - - [Credits](#credits) - - [Copyright](#copyright) - # OpenSearch.org website -This repo contains the source for the [opensearch.org](https://opensearch.org/) website. +Opensearch.org is now hosted by the Linux Foundation. This repo contains the source for the [opensearch.org](https://opensearch.org/) website as it existed as a statically generated Jekyll site. It is now a content repository instead of a code repository. -## Getting help +PRs are still used for intake and editorial. -If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. +## Getting help -If you need help and are unsure where to open an issue, try [forums](https://forum.opensearch.org/). +If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. If you need help and are unsure where to open an issue, try [forums](https://forum.opensearch.org/) or our [slack instance](https://www.opensearch.org/slack.html). ## Contributing @@ -52,57 +38,9 @@ For writing guidelines, see the [OpenSearch Project Style Guidelines](https://gi If you need help, contact [pajuric](https://github.com/pajuric). -### Building the website - -This site uses [Jekyll](https://jekyllrb.com/). You can build the site and make it available on a local server via `docker-compose up -d`, or by installing all the dependencies on your local environment as follows (tested to work with Ruby 2.7.2). - -1. Install [Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/), then run `bundle install`. -2. Build and start Jekyll with `bundle exec jekyll serve`. -3. Browse the site at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). - -Alternatively, build the site with `bundle exec jekyll build`. The HTML output is generated into `/_site`. For the full configuration options when running Jekyll, see [this page](https://jekyllrb.com/docs/configuration/options/). - -A full site build takes around 20 seconds. If you want to shave off some time, you can build the development version which lacks the sitemap.xml (which is very time consuming to build). The development version takes about 3 seconds to build, so it's great for fast iteration but not exactly what will be built in deployment (it's very close). - -``` -BUNDLE_GEMFILE=Gemfile-dev bundle exec jekyll serve --config ./_config-dev.yml -``` - -#### Content Modifier - -In order to automatically mitigate some common security risks, the generated pages are scanned and modified, during build, by the [`ContentModifier` plugin](_plugins/content-modifier.rb). Due to its impact on build times, the plugin does not run when developing locally using `jekyll serve`. This behavior can be changed to force the execution of plugin while serving by adding the ENV flag `JEKYLL_ALLOW_CONTENT_MODIFIER`. E.g. -```sh -JEKYLL_ALLOW_CONTENT_MODIFIER= bundle exec jekyll serve -``` - -### Search bar invisible pages - -To prevent a document from appearing in search results, you can add `omit_from_search: true` to its front matter. - - -### Testing - -#### Link checker - -We use a link checker plugin to ensure that we don't have any broken links on the website. It does not run by default since it can slow down the build, especially when running `bundle exec jekyll serve`. To run the link checker, add the ENV flag `JEKYLL_LINK_CHECKER` or `JEKYLL_FATAL_LINK_CHECKER` with any one of the valid values `internal`,`forced`,`all` or `retry`. Each option tests a larger range of links. E.g. - -```sh -JEKYLL_FATAL_LINK_CHECKER=all bundle exec jekyll build -``` - -**`JEKYLL_LINK_CHECKER` vs `JEKYLL_FATAL_LINK_CHECKER`** - -They both accept the same values with the only difference being that `JEKYLL_FATAL_LINK_CHECKER` fails the build if a broken link is found - -**Env values** -1. **internal**: validates only the internal links -2. **forced**: validates internal links and links that are technically internal but instead link to an external page. e.g. `/docs` -3. **all**: validates all links. however this option does not retry retry-able link or follow redirection links. e.g. HTTP:429 (too many attempts, retry after), HTTP:301 (Permanent redirect) -4. **retry**: validates all the links but also retries links with retry-able HTTP header - ## Code of Conduct -This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. +This project has adopted the [OpenSearch Code of Conduct](CODE_OF_CONDUCT.md). See [NOTICE](https://github.com/opensearch-project/.github/blob/main/NOTICE.txt) for details. ## Security From b5d0c9f04eb0f3c10531fb6a796ad1f34e5f81ef Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 13:26:21 -0700 Subject: [PATCH 2/7] Changed Partner to Solutions Provider, added link to submit application for new solutions provider. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ae4135be8..13607ebc0e 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) page to _Note:_ As of July 20, 2021, contributions are welcome on the `main` branch; the `prod` branch is now protected and holds the finalized version of the site. The `staging` branch has been removed and is no longer being used. -### Adding to the Partners page +### Becoming a Solutions Provider -If you are a partner, you are welcome to add your logo/link to our partners page. Please copy and edit the [sample file](_partners/_sample.md), and submit a pull request. +If you would like to become a Solutions Provider and be listed on our [solutions providers](https://opensearch.org/solutions-providers/), [submit your application](https://github.com/opensearch-project/project-website/issues/new?template=solutions_provider_update.md) through Github. ### Writing a blog From 7163eae884c9bc87c33bcd4e3e98bba57d540fed Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 13:36:07 -0700 Subject: [PATCH 3/7] Strikeout markdown. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index d7b0c315dc..8cb75fd0f2 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -81,13 +81,13 @@ If you want to specify the image width or another style, use HTML syntax: Similar vectors ``` -~~ -To center a Markdown image, specify the `img-centered` class for the image: +~~To center a Markdown image, specify the `img-centered` class for the image:~~ ``` ![Similar vectors](/assets/media/blog-images/2023-02-13-semantic-search-solutions/vectors.jpg){:class="img-centered"} ``` -~~ + + ^ The markdown convention that Jekyll uses for adding CSS classes causes issues with our publishing process. Please refrain from using it. Use the raw HTML methodology below. To center an HTML image, include `class="centered"` in the image tag: From 6219ac27d630764d0f572d5986c760a8021569f7 Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 14:47:29 -0700 Subject: [PATCH 4/7] Can I strikeout preformatted text? Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index 8cb75fd0f2..6bbf4ce1c0 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -83,9 +83,7 @@ If you want to specify the image width or another style, use HTML syntax: ~~To center a Markdown image, specify the `img-centered` class for the image:~~ -``` -![Similar vectors](/assets/media/blog-images/2023-02-13-semantic-search-solutions/vectors.jpg){:class="img-centered"} -``` +~~```![Similar vectors](/assets/media/blog-images/2023-02-13-semantic-search-solutions/vectors.jpg){:class="img-centered"}```~~ ^ The markdown convention that Jekyll uses for adding CSS classes causes issues with our publishing process. Please refrain from using it. Use the raw HTML methodology below. From 1e79842bc16c6683db7d81c1ce0339ef9e4b5c23 Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 14:53:24 -0700 Subject: [PATCH 5/7] Blog guide updates. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index 6bbf4ce1c0..8d0589d8e1 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -37,8 +37,6 @@ categories: meta_keywords: semantic search engine, neural search engine, keyword and natural language search, search relevance, benchmarking tests meta_description: Learn how to create a semantic search engine in OpenSearch, including architecture and model options, benchmarking tests, and effects of different combination strategies and normalization protocols. excerpt: In an earlier blog post, we described different ways of building a semantic search engine in OpenSearch. In this post, we'll dive further into the science behind it. We'll discuss the benefits of combining keyword-based search with neural search, the architecture and model options, and benchmarking tests and results. First, we'll provide an overview of our proposed solutions and a summary of the main results. Next, we'll outline the steps for creating a solution and fine-tuning it for your own document corpus. Finally, we'll discuss the effects of different combination strategies and normalization protocols on search relevance. -has_math: true -has_science_table: true --- ``` @@ -54,8 +52,10 @@ Variable | Description `meta_keywords` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `meta_description` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `excerpt` | (Optional) A blog excerpt you want to appear on the [blog front page](https://opensearch.org/blog). If you don't provide this variable, the excerpt will contain the first paragraph of the blog. If you do provide your own excerpt, make sure it does not contain any special Markdown formatting because this formatting will be ignored and displayed as is. For example, if you surround a word with tic marks, the tic marks will be displayed rather than formatting the variable in code font. -`has_math` | (Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas. -`has_science_table` | (Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`. +~~`has_math` | (Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas.~~ +~~`has_science_table` | (Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`.~~ + +*Note:* `has_math` and `has_science_table` are no longer used. ## Title From da128ee552f554fa376e533af0c44efefb853c27 Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 14:54:32 -0700 Subject: [PATCH 6/7] Strikeout. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index 8d0589d8e1..27948b32be 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -52,8 +52,8 @@ Variable | Description `meta_keywords` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `meta_description` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `excerpt` | (Optional) A blog excerpt you want to appear on the [blog front page](https://opensearch.org/blog). If you don't provide this variable, the excerpt will contain the first paragraph of the blog. If you do provide your own excerpt, make sure it does not contain any special Markdown formatting because this formatting will be ignored and displayed as is. For example, if you surround a word with tic marks, the tic marks will be displayed rather than formatting the variable in code font. -~~`has_math` | (Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas.~~ -~~`has_science_table` | (Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`.~~ +`~~has_math~~` | ~~(Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas.~~ +`~~has_science_table~~` | ~~(Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`.~~ *Note:* `has_math` and `has_science_table` are no longer used. From 9e8f38adf3c0f9b5b47efcd1d50b9c852d8f81f2 Mon Sep 17 00:00:00 2001 From: Nate B <96254688+nateynateynate@users.noreply.github.com> Date: Tue, 30 Sep 2025 14:55:22 -0700 Subject: [PATCH 7/7] STrikeout. Signed-off-by: Nate B <96254688+nateynateynate@users.noreply.github.com> --- BLOG_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/BLOG_GUIDE.md b/BLOG_GUIDE.md index 27948b32be..f145cfd3d5 100644 --- a/BLOG_GUIDE.md +++ b/BLOG_GUIDE.md @@ -52,8 +52,8 @@ Variable | Description `meta_keywords` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `meta_description` | Meta keywords are provided by the marketing team once you put up a PR with the blog post. `excerpt` | (Optional) A blog excerpt you want to appear on the [blog front page](https://opensearch.org/blog). If you don't provide this variable, the excerpt will contain the first paragraph of the blog. If you do provide your own excerpt, make sure it does not contain any special Markdown formatting because this formatting will be ignored and displayed as is. For example, if you surround a word with tic marks, the tic marks will be displayed rather than formatting the variable in code font. -`~~has_math~~` | ~~(Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas.~~ -`~~has_science_table~~` | ~~(Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`.~~ +~~has_math~~ | ~~(Optional) If your blog post contains mathematical formulas, set this variable to `true` so you can use the [MathJax](https://www.mathjax.org/) syntax to render the formulas.~~ +~~has_science_table~~ | ~~(Optional) By default, tables do not render grid lines. To add grid lines to your table, set this variable to `true`.~~ *Note:* `has_math` and `has_science_table` are no longer used.