From e55c70d9cfba354d11321e8964a21d667cd02d1c Mon Sep 17 00:00:00 2001 From: Markus Kalkbrenner Date: Thu, 4 Jan 2024 09:48:47 +0100 Subject: [PATCH 1/3] Create .readthedocs.yaml --- .readthedocs.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..376dcc3a9 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +# Read the Docs configuration file for MkDocs projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +mkdocs: + configuration: mkdocs.yml From 005de702a6a6c7fe462e7b1509020cd4816d6f08 Mon Sep 17 00:00:00 2001 From: Markus Kalkbrenner Date: Fri, 5 Jan 2024 11:11:36 +0100 Subject: [PATCH 2/3] list all pages --- mkdocs.yml | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 4d361defa..94503d2f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,77 @@ nav: - 'Getting Started': 'getting-started.md' - 'Solarium Concepts': 'solarium-concepts.md' - 'Client and Adapters': 'client-and-adapters.md' + - 'Queries': + - 'queries/select-query/select-query.md' + - 'queries/select-query/executing-a-select-query.md' + - 'queries/select-query/building-a-select-query/adding-filterqueries.md' + - 'queries/select-query/building-a-select-query/building-a-select-query.md' + - 'queries/select-query/building-a-select-query/components/analytics-component.md' + - 'queries/select-query/building-a-select-query/components/components.md' + - 'queries/select-query/building-a-select-query/components/debug-component.md' + - 'queries/select-query/building-a-select-query/components/dismax-component.md' + - 'queries/select-query/building-a-select-query/components/distributed-search-component.md' + - 'queries/select-query/building-a-select-query/components/edismax-component.md' + - 'queries/select-query/building-a-select-query/components/grouping-component.md' + - 'queries/select-query/building-a-select-query/components/highlighting-component.md' + - 'queries/select-query/building-a-select-query/components/morelikethis-component.md' + - 'queries/select-query/building-a-select-query/components/query-elevation-component.md' + - 'queries/select-query/building-a-select-query/components/query-rerankquery-component.md' + - 'queries/select-query/building-a-select-query/components/spellcheck-component.md' + - 'queries/select-query/building-a-select-query/components/stats-component.md' + - 'queries/select-query/building-a-select-query/components/termvector-component.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facet-field.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facet-multiquery.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facet-pivot.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facet-query.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facet-range.md' + - 'queries/select-query/building-a-select-query/components/facetset-component/facetset-component.md' + - 'queries/select-query/result-of-a-select-query/result-of-a-select-query.md' + - 'queries/select-query/result-of-a-select-query/component-results/component-results.md' + - 'queries/select-query/result-of-a-select-query/component-results/facetset-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/grouping-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/highlighting-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/morelikethis-result.md' + - 'queries/select-query/re-use-of-queries.md' + - 'queries/update-query/update-query.md' + - 'queries/update-query/executing-an-update-query.md' + - 'queries/update-query/building-an-update-query/add-command.md' + - 'queries/update-query/building-an-update-query/building-an-update-query.md' + - 'queries/update-query/building-an-update-query/commit-command.md' + - 'queries/update-query/building-an-update-query/delete-command.md' + - 'queries/update-query/building-an-update-query/optimize-command.md' + - 'queries/update-query/building-an-update-query/rawxml-command.md' + - 'queries/update-query/building-an-update-query/rollback-command.md' + - 'queries/update-query/the-result-of-an-update-query.md' + - 'queries/update-query/best-practices-for-updates.md' + - 'queries/extract-query.md' + - 'queries/morelikethis-query.md' + - 'queries/ping-query.md' + - 'queries/realtimeget-query.md' + - 'queries/suggester-query.md' + - 'queries/terms-query.md' + - 'Analysis': + - 'queries/analysis-query/analysis-query.md' + - 'queries/analysis-query/analysis-document.md' + - 'queries/analysis-query/analysis-field.md' + - 'queries/luke-query/luke-query.md' + - 'queries/luke-query/result-of-a-luke-query/all-fields.md' + - 'queries/luke-query/result-of-a-luke-query/document.md' + - 'queries/luke-query/result-of-a-luke-query/field-details.md' + - 'queries/luke-query/result-of-a-luke-query/index-details.md' + - 'queries/luke-query/result-of-a-luke-query/info.md' + - 'queries/luke-query/result-of-a-luke-query/schema.md' + - 'Managed Resources': + - 'queries/managedresources-query/managed-resources.md' + - 'queries/managedresources-query/managed-stopwords.md' + - 'queries/managedresources-query/managed-synonyms.md' + - 'queries/server-query/core-admin-query.md' + - 'Query Helper': + - 'queries/query-helper/escaping.md' + - 'queries/query-helper/function-builder.md' + - 'queries/query-helper/geospatial-support.md' + - 'queries/query-helper/placeholders.md' + - 'queries/query-helper/query-helper.md' - 'Documents': 'documents.md' - 'Customizing': 'customizing-solarium.md' - 'Plugins': 'plugins.md' From 557c38f6a6fba7fa643a7c7c9bd68f9e802b6acc Mon Sep 17 00:00:00 2001 From: Markus Kalkbrenner Date: Fri, 5 Jan 2024 11:20:35 +0100 Subject: [PATCH 3/3] fixed yaml structure --- mkdocs.yml | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 94503d2f4..312b31c45 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,8 +8,10 @@ nav: - 'Solarium Concepts': 'solarium-concepts.md' - 'Client and Adapters': 'client-and-adapters.md' - 'Queries': - - 'queries/select-query/select-query.md' + - 'Select Query': + - 'queries/select-query/select-query.md' - 'queries/select-query/executing-a-select-query.md' + - 'Building a Select Query': - 'queries/select-query/building-a-select-query/adding-filterqueries.md' - 'queries/select-query/building-a-select-query/building-a-select-query.md' - 'queries/select-query/building-a-select-query/components/analytics-component.md' @@ -32,15 +34,19 @@ nav: - 'queries/select-query/building-a-select-query/components/facetset-component/facet-query.md' - 'queries/select-query/building-a-select-query/components/facetset-component/facet-range.md' - 'queries/select-query/building-a-select-query/components/facetset-component/facetset-component.md' - - 'queries/select-query/result-of-a-select-query/result-of-a-select-query.md' - - 'queries/select-query/result-of-a-select-query/component-results/component-results.md' - - 'queries/select-query/result-of-a-select-query/component-results/facetset-result.md' - - 'queries/select-query/result-of-a-select-query/component-results/grouping-result.md' - - 'queries/select-query/result-of-a-select-query/component-results/highlighting-result.md' - - 'queries/select-query/result-of-a-select-query/component-results/morelikethis-result.md' + - 'Result of a Select Query': + - 'queries/select-query/result-of-a-select-query/result-of-a-select-query.md' + - 'Component Results': + - 'queries/select-query/result-of-a-select-query/component-results/component-results.md' + - 'queries/select-query/result-of-a-select-query/component-results/facetset-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/grouping-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/highlighting-result.md' + - 'queries/select-query/result-of-a-select-query/component-results/morelikethis-result.md' - 'queries/select-query/re-use-of-queries.md' - - 'queries/update-query/update-query.md' + - 'Update Query': + - 'queries/update-query/update-query.md' - 'queries/update-query/executing-an-update-query.md' + - 'Building an Update Query': - 'queries/update-query/building-an-update-query/add-command.md' - 'queries/update-query/building-an-update-query/building-an-update-query.md' - 'queries/update-query/building-an-update-query/commit-command.md' @@ -60,13 +66,15 @@ nav: - 'queries/analysis-query/analysis-query.md' - 'queries/analysis-query/analysis-document.md' - 'queries/analysis-query/analysis-field.md' - - 'queries/luke-query/luke-query.md' - - 'queries/luke-query/result-of-a-luke-query/all-fields.md' - - 'queries/luke-query/result-of-a-luke-query/document.md' - - 'queries/luke-query/result-of-a-luke-query/field-details.md' - - 'queries/luke-query/result-of-a-luke-query/index-details.md' - - 'queries/luke-query/result-of-a-luke-query/info.md' - - 'queries/luke-query/result-of-a-luke-query/schema.md' + - 'Luke': + - 'queries/luke-query/luke-query.md' + - 'Result': + - 'queries/luke-query/result-of-a-luke-query/all-fields.md' + - 'queries/luke-query/result-of-a-luke-query/document.md' + - 'queries/luke-query/result-of-a-luke-query/field-details.md' + - 'queries/luke-query/result-of-a-luke-query/index-details.md' + - 'queries/luke-query/result-of-a-luke-query/info.md' + - 'queries/luke-query/result-of-a-luke-query/schema.md' - 'Managed Resources': - 'queries/managedresources-query/managed-resources.md' - 'queries/managedresources-query/managed-stopwords.md'