Skip to content

Commit 54f7540

Browse files
committed
Update search config
Signed-off-by: Ian Maddaus <[email protected]>
1 parent e80ba8f commit 54f7540

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

config/_default/params.toml

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,30 @@ robots = ''
2626
[license-service]
2727
gh_path = "https://github.com/chef/license-service/tree/main/docs-chef-io/content/"
2828

29-
[search]
29+
######### Site search ##########
30+
#
3031
# This populates the site search page with search filter parameters.
32+
#
33+
# 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
34+
# Use an empty string ("") for pages without a defined product.
35+
# Include the latest/newest version of products that have muliple versions of documentation deployed.
36+
#
37+
# search.products.<PRODUCT> = A map/object/dictionary/table/whatever of products and their versions.
38+
# This populates the left product search filter with product names and versions.
39+
#
40+
# name = The product name as it appears in the UI.
41+
# product_key, product_version_key = The key used to filter results by in Swiftype API calls.
42+
# This product key is defined in the documatation frontmatter.
43+
# For example, the "habitat" key is defined in the docs.chef.io/habitat page frontmatter.
44+
# See here for example: https://github.com/habitat-sh/habitat/blob/main/components/docs-chef-io/content/habitat/_index.md?plain=1#L7
45+
#
46+
# search.products.<PRODUCT>.versions = A table of versions for a product.
47+
# Versions must be in order from newest/latest version to oldest and must be a string.
48+
#
49+
################################
3150

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

34-
# 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
35-
# Use an empty string ("") for pages without a defined product
36-
# This includes the latest/newest version of products that have muliple versions of documentation deployed.
3753
default_search_product_keys = ["", "chef-360-1.0", "automate", "desktop", "habitat", "client", "server", "inspec", "saas", "supermarket", "workstation"]
3854

3955
[search.products]
@@ -66,14 +82,6 @@ product_key = "habitat"
6682
name = "Infra Client"
6783
product_key = "client"
6884

69-
[[search.products.infra_client.versions]]
70-
name = '18.0'
71-
product_version_key = 'client-18.0'
72-
73-
[[search.products.infra_client.versions]]
74-
name = '17'
75-
product_version_key = 'client-17'
76-
7785
[search.products.infra_server]
7886
name = "Infra Server"
7987
product_key = "server"

0 commit comments

Comments
 (0)