Skip to content

Commit

Permalink
Update search config
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Nov 14, 2024
1 parent e80ba8f commit 54f7540
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,30 @@ robots = ''
[license-service]
gh_path = "https://github.com/chef/license-service/tree/main/docs-chef-io/content/"

[search]
######### Site search ##########
#
# This populates the site search page with search filter parameters.
#
# default_search_product_keys = The product search keys that are returned by search by default, ie when no product is selected in the search filters
# Use an empty string ("") for pages without a defined product.
# Include the latest/newest version of products that have muliple versions of documentation deployed.
#
# search.products.<PRODUCT> = A map/object/dictionary/table/whatever of products and their versions.
# This populates the left product search filter with product names and versions.
#
# name = The product name as it appears in the UI.
# product_key, product_version_key = The key used to filter results by in Swiftype API calls.
# This product key is defined in the documatation frontmatter.
# For example, the "habitat" key is defined in the docs.chef.io/habitat page frontmatter.
# See here for example: https://github.com/habitat-sh/habitat/blob/main/components/docs-chef-io/content/habitat/_index.md?plain=1#L7
#
# search.products.<PRODUCT>.versions = A table of versions for a product.
# Versions must be in order from newest/latest version to oldest and must be a string.
#
################################

# versions must be in order from newest/latest version to oldest and must be a string.
[search]

# default_search_product_keys defines the product search keys that are returned by search by default, ie when no product is selected in the search filters
# Use an empty string ("") for pages without a defined product
# This includes the latest/newest version of products that have muliple versions of documentation deployed.
default_search_product_keys = ["", "chef-360-1.0", "automate", "desktop", "habitat", "client", "server", "inspec", "saas", "supermarket", "workstation"]

[search.products]
Expand Down Expand Up @@ -66,14 +82,6 @@ product_key = "habitat"
name = "Infra Client"
product_key = "client"

[[search.products.infra_client.versions]]
name = '18.0'
product_version_key = 'client-18.0'

[[search.products.infra_client.versions]]
name = '17'
product_version_key = 'client-17'

[search.products.infra_server]
name = "Infra Server"
product_key = "server"
Expand Down

0 comments on commit 54f7540

Please sign in to comment.