diff --git a/dev-tools/scripts/refguide/gen-refguide-redirects.py b/dev-tools/scripts/refguide/gen-refguide-redirects.py new file mode 100755 index 000000000000..155e1aec793d --- /dev/null +++ b/dev-tools/scripts/refguide/gen-refguide-redirects.py @@ -0,0 +1,155 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" +Simple script that converts old refguide page names as of 8.11.1 to the new Antora URLs from 9.0 +See input files in folder gen-refguide-redirects/ + +The old-guide.txt is the plain .adoc names from an 'ls | grep adoc' in old ref-guide src folder +The new-guide.txt is the output from this command from the new repo in the 'modules' folder: + find . | grep adoc | sed 's/\/pages//g' | sed 's/^.\///g' +The mappings.csv comes from the explicit page renamings sourced from spreadsheet + https://docs.google.com/spreadsheets/d/1mwxSpn5Ky7-P4DLFrJGel2h7Il4muTlHmAA-AuRY1rs/edit#gid=982988701 +""" + +import os +import sys +from pprint import pprint +sys.path.append(os.path.dirname(__file__)) +import argparse + + +def read_config(): + parser = argparse.ArgumentParser(description='Convert old refguide page names to new') + parser.add_argument('--old', required=True, help='Old pagenames file, one .adoc filename per line') + parser.add_argument('--new', required=True, help='New pagenames file, one .adoc filename per line') + parser.add_argument('--mapping', required=True, help='Semicolon separated from-to file names (adoc)') + parser.add_argument('--htaccess', action='store_true', default=False, help='Output as htaccess rules') + newconf = parser.parse_args() + return newconf + + +def out(text): + global conf + if not conf.htaccess: + print(text) + + +def lines_from_file(filename): + with open(filename, 'r') as fp: + lines = [] + for line in fp.readlines(): + if line.startswith("#") or len(line.strip()) == 0: + continue + lines.append(line.replace(".adoc", ".html").strip()) + return lines + + +def main(): + global conf + conf = read_config() + + new = {} + name_map = {} + + out("Reading config") + old = lines_from_file(conf.old) + for line in lines_from_file(conf.new): + (path, file) = line.split("/") + new[file] = line + for line in lines_from_file(conf.mapping): + (frm, to) = line.split(";") + name_map[frm] = to + + # Files in src/old-pages as of 2022-02-04 + old_pages = ["configuration-apis.html", "configuration-guide.html", "controlling-results.html", "deployment-guide.html", "enhancing-queries.html", "field-types.html", "fields-and-schema-design.html", "getting-started.html", "indexing-data-operations.html", "installation-deployment.html", "monitoring-solr.html", "query-guide.html", "scaling-solr.html", "schema-indexing-guide.html", "solr-concepts.html", "solr-schema.html", "solrcloud-clusters.html", "user-managed-clusters.html"] + + result = {} + old_guide = [] + failed = {} + regex_new = {} + out("Converting...") + for frm in old: + if frm in new: + (subpath, name) = new[frm].split("/") + if subpath not in regex_new: + regex_new[subpath] = [] + regex_new[subpath].append(name.split(".html")[0]) + elif frm in name_map: + new_name = name_map[frm] + new_name_without_anchor = new_name + anchor = "" + anchor_index = new_name.find("#") + if anchor_index > 0: + new_name_without_anchor = new_name[:anchor_index] + anchor = new_name[anchor_index:] + if new_name_without_anchor.startswith("https://"): + result[frm] = new_name + elif new_name_without_anchor in new: + result[frm] = new[new_name_without_anchor] + anchor + elif new_name_without_anchor.startswith("/guide/"): + result[frm] = new_name[7:] + elif new_name_without_anchor == "_8_11": + old_guide.append(frm.split(".html")[0]) + else: + failed[frm] = "Mapped value %s not in new guide" % new_name_without_anchor + elif frm in old_pages: + failed[frm] = "Not yet mapped (in src/old-pages)" + else: + failed[frm] = "404" + + if conf.htaccess: + print("# Existing pages moved to sub path") + for key in regex_new: + print("RedirectMatch 301 ^/guide/(%s)\.html /guide/solr/latest/%s/$1.html" % ("|".join(regex_new[key]), key)) + print("# Page renames in 9.0") + for key in result: + if result[key].startswith("https://"): + print("RewriteRule ^guide/%s %s [R=301,NE,L]" % (key, result[key])) + else: + print("RewriteRule ^guide/%s /guide/solr/latest/%s [R=301,NE,L]" % (key, result[key])) + print("# Removed pages redirected to latest 8.x guide") + old_version_pages_regex = "(%s)\.html" % "|".join(old_guide) + print("RedirectMatch 301 ^/guide/%s /guide/8_11/$1.html" % old_version_pages_regex) + print("# Paths we could not map") + for key in failed: + print("# %s: %s" % (key, failed[key])) + + print(""" + +# Do not index old reference guide pages on search engines, except for pages that don't exist in 9+ + + + Header set X-Robots-Tag "noindex,nofollow,noarchive" + +""" % old_version_pages_regex) + else: + out("Regex mappings:") + pprint(regex_new) + out("Rename mappings:") + pprint(result) + out("Old refGuide mappings:") + pprint(old_guide) + out("Failed mappings:") + pprint(failed) + + +if __name__ == '__main__': + try: + main() + except KeyboardInterrupt: + print('\nReceived Ctrl-C, exiting early') diff --git a/dev-tools/scripts/refguide/htaccess.txt b/dev-tools/scripts/refguide/htaccess.txt new file mode 100644 index 000000000000..fdb04cdaca7f --- /dev/null +++ b/dev-tools/scripts/refguide/htaccess.txt @@ -0,0 +1,123 @@ +# Existing pages moved to sub path +RedirectMatch 301 ^/guide/(about-this-guide|relevance|solr-glossary|solr-tutorial)\.html /guide/solr/latest/getting-started/$1.html +RedirectMatch 301 ^/guide/(aliases|audit-logging|authentication-and-authorization-plugins|basic-authentication-plugin|circuit-breakers|client-apis|cloud-screens|cluster-node-management|collection-management|collections-core-admin|configuring-logging|enabling-ssl|hadoop-authentication-plugin|indexupgrader-tool|installing-solr|jvm-settings|jwt-authentication-plugin|kerberos-authentication-plugin|mbean-request-handler|metrics-reporting|performance-statistics-reference|ping|plugins-stats-screen|replica-management|rule-based-authorization-plugin|securing-solr|security-ui|shard-management|solr-control-script-reference|solrcloud-recoveries-and-write-tolerance|solrcloud-with-legacy-configuration-files|taking-solr-to-production|thread-dump|upgrading-a-solr-cluster|zookeeper-access-control)\.html /guide/solr/latest/deployment-guide/$1.html +RedirectMatch 301 ^/guide/(analysis-screen|analyzers|charfilterfactories|content-streams|de-duplication|documents-screen|docvalues|dynamic-fields|field-properties-by-use-case|field-type-definitions-and-properties|field-types-included-with-solr|indexing-nested-documents|language-analysis|luke-request-handler|phonetic-matching|post-tool|reindexing|schema-api|schema-browser-screen|schema-designer|schemaless-mode|tokenizers|transforming-and-indexing-custom-json)\.html /guide/solr/latest/indexing-guide/$1.html +RedirectMatch 301 ^/guide/(analytics-expression-sources|analytics-mapping-functions|analytics-reduction-functions|analytics|collapse-and-expand-results|common-query-parameters|computational-geometry|curve-fitting|dsp|exporting-result-sets|faceting|function-queries|graph-traversal|graph|highlighting|json-facet-api|json-faceting-domain-changes|json-query-dsl|json-request-api|learning-to-rank|loading|logs|machine-learning|math-expressions|math-start|matrix-math|morelikethis|numerical-analysis|other-parsers|pagination-of-results|probability-distributions|query-re-ranking|query-screen|regression|response-writers|result-grouping|scalar-math|search-sample|searching-nested-documents|simulations|spatial-search|spell-checking|statistics|stream-api|stream-decorator-reference|stream-evaluator-reference|stream-screen|stream-source-reference|streaming-expressions|suggester|term-vectors|time-series|transform|variables|vector-math|visualization)\.html /guide/solr/latest/query-guide/$1.html +RedirectMatch 301 ^/guide/(codec-factory|collections-api|config-api|config-sets|configsets-api|configuring-solrconfig-xml|coreadmin-api|implicit-requesthandlers|libs|managed-resources|package-manager-internals|package-manager|realtime-get|request-parameters-api|resource-loading|solr-plugins|update-request-processors|v2-api)\.html /guide/solr/latest/configuration-guide/$1.html +RedirectMatch 301 ^/guide/(major-changes-in-solr-7|major-changes-in-solr-8|solr-upgrade-notes)\.html /guide/solr/latest/upgrade-notes/$1.html +# Page renames in 9.0 +RewriteRule ^guide/a-quick-overview.html /guide/solr/latest/getting-started/introduction.html [R=301,NE,L] +RewriteRule ^guide/about-filters.html /guide/solr/latest/indexing-guide/filters.html [R=301,NE,L] +RewriteRule ^guide/about-tokenizers.html /guide/solr/latest/indexing-guide/tokenizers.html [R=301,NE,L] +RewriteRule ^guide/aws-solrcloud-tutorial.html /guide/solr/latest/getting-started/tutorial-aws.html [R=301,NE,L] +RewriteRule ^guide/choosing-an-output-format.html /guide/solr/latest/deployment-guide/client-apis.html [R=301,NE,L] +RewriteRule ^guide/client-api-lineup.html /guide/solr/latest/deployment-guide/client-apis.html [R=301,NE,L] +RewriteRule ^guide/collection-aliasing.html /guide/solr/latest/deployment-guide/alias-management.html [R=301,NE,L] +RewriteRule ^guide/collection-specific-tools.html /guide/solr/latest/getting-started/solr-admin-ui.html [R=301,NE,L] +RewriteRule ^guide/combining-distribution-and-replication.html /guide/solr/latest/deployment-guide/user-managed-distributed-search.html [R=301,NE,L] +RewriteRule ^guide/command-line-utilities.html /guide/solr/latest/deployment-guide/zookeeper-utilities.html [R=301,NE,L] +RewriteRule ^guide/configuration-apis.html /guide/solr/latest/configuration-guide/config-api.html [R=301,NE,L] +RewriteRule ^guide/copying-fields.html /guide/solr/latest/indexing-guide/copy-fields.html [R=301,NE,L] +RewriteRule ^guide/core-specific-tools.html /guide/solr/latest/getting-started/solr-admin-ui.html [R=301,NE,L] +RewriteRule ^guide/datadir-and-directoryfactory-in-solrconfig.html /guide/solr/latest/configuration-guide/index-location-format.html [R=301,NE,L] +RewriteRule ^guide/defining-core-properties.html /guide/solr/latest/configuration-guide/core-discovery.html [R=301,NE,L] +RewriteRule ^guide/defining-fields.html /guide/solr/latest/indexing-guide/fields.html [R=301,NE,L] +RewriteRule ^guide/deployment-and-operations.html /guide/solr/latest/deployment-guide/installing-solr.html [R=301,NE,L] +RewriteRule ^guide/detecting-languages-during-indexing.html /guide/solr/latest/indexing-guide/language-detection.html [R=301,NE,L] +RewriteRule ^guide/distributed-requests.html /guide/solr/latest/deployment-guide/solrcloud-distributed-requests.html [R=301,NE,L] +RewriteRule ^guide/distributed-search-with-index-sharding.html /guide/solr/latest/deployment-guide/user-managed-distributed-search.html [R=301,NE,L] +RewriteRule ^guide/documents-fields-and-schema-design.html /guide/solr/latest/indexing-guide/fields.html [R=301,NE,L] +RewriteRule ^guide/files-screen.html /guide/solr/latest/configuration-guide/configuration-files.html [R=301,NE,L] +RewriteRule ^guide/filter-descriptions.html /guide/solr/latest/indexing-guide/filters.html [R=301,NE,L] +RewriteRule ^guide/format-of-solr-xml.html /guide/solr/latest/configuration-guide/configuring-solr-xml.html [R=301,NE,L] +RewriteRule ^guide/further-assistance.html https://solr.apache.org/community.html [R=301,NE,L] +RewriteRule ^guide/getting-started-with-solrcloud.html /guide/solr/latest/getting-started/tutorial-solrcloud.html [R=301,NE,L] +RewriteRule ^guide/getting-started.html /guide/solr/latest/getting-started/introduction.html [R=301,NE,L] +RewriteRule ^guide/how-solrcloud-works.html /guide/solr/latest/deployment-guide/cluster-types.html#solrcloud-mode [R=301,NE,L] +RewriteRule ^guide/how-to-contribute.html https://solr.apache.org/community.html#how-to-contribute [R=301,NE,L] +RewriteRule ^guide/index-replication.html /guide/solr/latest/deployment-guide/user-managed-index-replication.html [R=301,NE,L] +RewriteRule ^guide/indexconfig-in-solrconfig.html /guide/solr/latest/configuration-guide/index-segments-merging.html [R=301,NE,L] +RewriteRule ^guide/indexing-and-basic-data-operations.html /guide/solr/latest/indexing-guide/indexing-with-update-handlers.html [R=301,NE,L] +RewriteRule ^guide/initparams-in-solrconfig.html /guide/solr/latest/configuration-guide/initparams.html [R=301,NE,L] +RewriteRule ^guide/introduction-to-client-apis.html /guide/solr/latest/deployment-guide/client-apis.html [R=301,NE,L] +RewriteRule ^guide/introduction-to-scaling-and-distribution.html /guide/solr/latest/deployment-guide/cluster-types.html#user-managed-mode [R=301,NE,L] +RewriteRule ^guide/introduction-to-solr-indexing.html /guide/solr/latest/getting-started/solr-indexing.html [R=301,NE,L] +RewriteRule ^guide/java-properties.html /guide/solr/latest/deployment-guide/jvm-settings.html [R=301,NE,L] +RewriteRule ^guide/legacy-scaling-and-distribution.html /guide/solr/latest/deployment-guide/cluster-types.html#user-managed-mode [R=301,NE,L] +RewriteRule ^guide/local-parameters-in-queries.html /guide/solr/latest/query-guide/local-params.html [R=301,NE,L] +RewriteRule ^guide/logging.html /guide/solr/latest/deployment-guide/configuring-logging.html [R=301,NE,L] +RewriteRule ^guide/major-changes-from-solr-5-to-solr-6.html /guide/solr/latest/upgrade-notes/major-changes-in-solr-6.html [R=301,NE,L] +RewriteRule ^guide/making-and-restoring-backups.html /guide/solr/latest/deployment-guide/backup-restore.html [R=301,NE,L] +RewriteRule ^guide/merging-indexes.html /guide/solr/latest/configuration-guide/coreadmin-api.html [R=301,NE,L] +RewriteRule ^guide/monitoring-solr-with-prometheus-and-grafana.html /guide/solr/latest/deployment-guide/monitoring-with-prometheus-and-grafana.html [R=301,NE,L] +RewriteRule ^guide/monitoring-solr.html /guide/solr/latest/deployment-guide/configuring-logging.html [R=301,NE,L] +RewriteRule ^guide/near-real-time-searching.html /guide/solr/latest/configuration-guide/commits-transaction-logs.html [R=301,NE,L] +RewriteRule ^guide/other-schema-elements.html /guide/solr/latest/indexing-guide/schema-elements.html [R=301,NE,L] +RewriteRule ^guide/overview-of-documents-fields-and-schema-design.html /guide/solr/latest/getting-started/documents-fields-schema-design.html [R=301,NE,L] +RewriteRule ^guide/overview-of-searching-in-solr.html /guide/solr/latest/getting-started/searching-in-solr.html [R=301,NE,L] +RewriteRule ^guide/overview-of-the-solr-admin-ui.html /guide/solr/latest/getting-started/solr-admin-ui.html [R=301,NE,L] +RewriteRule ^guide/parallel-sql-interface.html /guide/solr/latest/query-guide/sql-query.html [R=301,NE,L] +RewriteRule ^guide/parameter-reference.html /guide/solr/latest/configuration-guide/configuring-solr-xml.html [R=301,NE,L] +RewriteRule ^guide/query-settings-in-solrconfig.html /guide/solr/latest/configuration-guide/caches-warming.html [R=301,NE,L] +RewriteRule ^guide/query-syntax-and-parsing.html /guide/solr/latest/query-guide/query-syntax-and-parsers.html [R=301,NE,L] +RewriteRule ^guide/replication-screen.html /guide/solr/latest/deployment-guide/user-managed-index-replication.html [R=301,NE,L] +RewriteRule ^guide/requestdispatcher-in-solrconfig.html /guide/solr/latest/configuration-guide/requestdispatcher.html [R=301,NE,L] +RewriteRule ^guide/requesthandlers-and-searchcomponents-in-solrconfig.html /guide/solr/latest/configuration-guide/requesthandlers-searchcomponents.html [R=301,NE,L] +RewriteRule ^guide/running-solr-on-hdfs.html /guide/solr/latest/deployment-guide/solr-on-hdfs.html [R=301,NE,L] +RewriteRule ^guide/running-your-analyzer.html /guide/solr/latest/indexing-guide/analysis-screen.html [R=301,NE,L] +RewriteRule ^guide/schema-factory-definition-in-solrconfig.html /guide/solr/latest/configuration-guide/schema-factory.html [R=301,NE,L] +RewriteRule ^guide/searching.html /guide/solr/latest/query-guide/query-syntax-and-parsers.html [R=301,NE,L] +RewriteRule ^guide/segments-info.html /guide/solr/latest/configuration-guide/index-segments-merging.html [R=301,NE,L] +RewriteRule ^guide/setting-up-an-external-zookeeper-ensemble.html /guide/solr/latest/deployment-guide/zookeeper-ensemble.html [R=301,NE,L] +RewriteRule ^guide/shards-and-indexing-data-in-solrcloud.html /guide/solr/latest/deployment-guide/solrcloud-shards-indexing.html [R=301,NE,L] +RewriteRule ^guide/solr-configuration-files.html /guide/solr/latest/configuration-guide/configuration-files.html [R=301,NE,L] +RewriteRule ^guide/solr-cores-and-solr-xml.html /guide/solr/latest/configuration-guide/core-discovery.html [R=301,NE,L] +RewriteRule ^guide/solr-field-types.html /guide/solr/latest/indexing-guide/field-type-definitions-and-properties.html [R=301,NE,L] +RewriteRule ^guide/solr-jdbc-apache-zeppelin.html /guide/solr/latest/query-guide/jdbc-zeppelin.html [R=301,NE,L] +RewriteRule ^guide/solr-jdbc-dbvisualizer.html /guide/solr/latest/query-guide/jdbc-dbvisualizer.html [R=301,NE,L] +RewriteRule ^guide/solr-jdbc-python-jython.html /guide/solr/latest/query-guide/jdbc-python-jython.html [R=301,NE,L] +RewriteRule ^guide/solr-jdbc-r.html /guide/solr/latest/query-guide/jdbc-r.html [R=301,NE,L] +RewriteRule ^guide/solr-jdbc-squirrel-sql.html /guide/solr/latest/query-guide/jdbc-squirrel.html [R=301,NE,L] +RewriteRule ^guide/solr-system-requirements.html /guide/solr/latest/deployment-guide/system-requirements.html [R=301,NE,L] +RewriteRule ^guide/solr-tracing.html /guide/solr/latest/deployment-guide/distributed-tracing.html [R=301,NE,L] +RewriteRule ^guide/solrcloud-configuration-and-parameters.html /guide/solr/latest/deployment-guide/solrcloud-shards-indexing.html [R=301,NE,L] +RewriteRule ^guide/solrcloud-query-routing-and-read-tolerance.html /guide/solr/latest/deployment-guide/solrcloud-distributed-requests.html [R=301,NE,L] +RewriteRule ^guide/solrcloud-resilience.html /guide/solr/latest/deployment-guide/solrcloud-recoveries-and-write-tolerance.html [R=301,NE,L] +RewriteRule ^guide/solrcloud.html /guide/solr/latest/deployment-guide/cluster-types.html#solrcloud-mode [R=301,NE,L] +RewriteRule ^guide/the-dismax-query-parser.html /guide/solr/latest/query-guide/dismax-query-parser.html [R=301,NE,L] +RewriteRule ^guide/the-extended-dismax-query-parser.html /guide/solr/latest/query-guide/edismax-query-parser.html [R=301,NE,L] +RewriteRule ^guide/the-query-elevation-component.html /guide/solr/latest/query-guide/query-elevation-component.html [R=301,NE,L] +RewriteRule ^guide/the-standard-query-parser.html /guide/solr/latest/query-guide/standard-query-parser.html [R=301,NE,L] +RewriteRule ^guide/the-stats-component.html /guide/solr/latest/query-guide/stats-component.html [R=301,NE,L] +RewriteRule ^guide/the-tagger-handler.html /guide/solr/latest/query-guide/tagger-handler.html [R=301,NE,L] +RewriteRule ^guide/the-term-vector-component.html /guide/solr/latest/query-guide/term-vector-component.html [R=301,NE,L] +RewriteRule ^guide/the-terms-component.html /guide/solr/latest/query-guide/terms-component.html [R=301,NE,L] +RewriteRule ^guide/the-well-configured-solr-instance.html /guide/solr/latest/configuration-guide/configuration-files.html [R=301,NE,L] +RewriteRule ^guide/transforming-result-documents.html /guide/solr/latest/query-guide/document-transformers.html [R=301,NE,L] +RewriteRule ^guide/understanding-analyzers-tokenizers-and-filters.html /guide/solr/latest/indexing-guide/document-analysis.html [R=301,NE,L] +RewriteRule ^guide/updatehandlers-in-solrconfig.html /guide/solr/latest/configuration-guide/commits-transaction-logs.html [R=301,NE,L] +RewriteRule ^guide/updating-parts-of-documents.html /guide/solr/latest/indexing-guide/partial-document-updates.html [R=301,NE,L] +RewriteRule ^guide/uploading-data-with-index-handlers.html /guide/solr/latest/indexing-guide/indexing-with-update-handlers.html [R=301,NE,L] +RewriteRule ^guide/uploading-data-with-solr-cell-using-apache-tika.html /guide/solr/latest/indexing-guide/indexing-with-tika.html [R=301,NE,L] +RewriteRule ^guide/using-javascript.html /guide/solr/latest/deployment-guide/javascript.html [R=301,NE,L] +RewriteRule ^guide/using-jmx-with-solr.html /guide/solr/latest/deployment-guide/jmx-with-solr.html [R=301,NE,L] +RewriteRule ^guide/using-python.html /guide/solr/latest/deployment-guide/python.html [R=301,NE,L] +RewriteRule ^guide/using-solr-from-ruby.html /guide/solr/latest/deployment-guide/ruby.html [R=301,NE,L] +RewriteRule ^guide/using-solrj.html /guide/solr/latest/deployment-guide/solrj.html [R=301,NE,L] +RewriteRule ^guide/using-the-solr-administration-user-interface.html /guide/solr/latest/getting-started/solr-admin-ui.html [R=301,NE,L] +RewriteRule ^guide/using-zookeeper-to-manage-configuration-files.html /guide/solr/latest/deployment-guide/zookeeper-file-management.html [R=301,NE,L] +RewriteRule ^guide/working-with-currencies-and-exchange-rates.html /guide/solr/latest/indexing-guide/currencies-exchange-rates.html [R=301,NE,L] +RewriteRule ^guide/working-with-dates.html /guide/solr/latest/indexing-guide/date-formatting-math.html [R=301,NE,L] +RewriteRule ^guide/working-with-enum-fields.html /guide/solr/latest/indexing-guide/enum-fields.html [R=301,NE,L] +RewriteRule ^guide/working-with-external-files-and-processes.html /guide/solr/latest/indexing-guide/external-files-processes.html [R=301,NE,L] +# Removed pages redirected to latest 8.x guide +RedirectMatch 301 ^/guide/(adding-custom-plugins-in-solrcloud-mode|blob-store-api|blockjoin-faceting|cdcr-api|cdcr-architecture|cdcr-config|cdcr-operations|colocating-collections|cross-data-center-replication-cdcr|dataimport-screen|errata|metrics-history|migrate-to-policy-rule|putting-the-pieces-together|rule-based-replica-placement|solrcloud-autoscaling-api|solrcloud-autoscaling-auto-add-replicas|solrcloud-autoscaling-fault-tolerance|solrcloud-autoscaling-listeners|solrcloud-autoscaling-overview|solrcloud-autoscaling-policy-preferences|solrcloud-autoscaling-trigger-actions|solrcloud-autoscaling-triggers|solrcloud-autoscaling|suggestions-screen|uploading-structured-data-store-data-with-the-data-import-handler|velocity-response-writer|velocity-search-ui)\.html /guide/8_11/$1.html +# Paths we could not map + + +# Do not index old reference guide pages on search engines, except for pages that don't exist in 9+ + + + Header set X-Robots-Tag "noindex,nofollow,noarchive" + + diff --git a/dev-tools/scripts/refguide/mappings.csv b/dev-tools/scripts/refguide/mappings.csv new file mode 100644 index 000000000000..fa8fa0b0cf54 --- /dev/null +++ b/dev-tools/scripts/refguide/mappings.csv @@ -0,0 +1,140 @@ +# Renamed pages +a-quick-overview.html;introduction.html +aws-solrcloud-tutorial.html;tutorial-aws.html +collection-aliasing.html;alias-management.html +command-line-utilities.html;zookeeper-utilities.html +datadir-and-directoryfactory-in-solrconfig.html;index-location-format.html +defining-core-properties.html;core-discovery.html +defining-fields.html;fields.html +copying-fields.html;copy-fields.html +detecting-languages-during-indexing.html;language-detection.html +distributed-requests.html;solrcloud-distributed-requests.html +distributed-search-with-index-sharding.html;user-managed-distributed-search.html +documents-fields-and-schema-design.html;fields-and-schema-design.html +filter-descriptions.html;filters.html +format-of-solr-xml.html;configuring-solr-xml.html +getting-started-with-solrcloud.html;tutorial-solrcloud.html +index-replication.html;user-managed-index-replication.html +indexconfig-in-solrconfig.html;index-segments-merging.html +indexing-and-basic-data-operations.html;indexing-with-update-handlers.html +initparams-in-solrconfig.html;initparams.html +introduction-to-solr-indexing.html;solr-indexing.html +local-parameters-in-queries.html;local-params.html +major-changes-from-solr-5-to-solr-6.html;major-changes-in-solr-6.html +making-and-restoring-backups.html;backup-restore.html +monitoring-solr-with-prometheus-and-grafana.html;monitoring-with-prometheus-and-grafana.html +other-schema-elements.html;schema-elements.html +overview-of-documents-fields-and-schema-design.html;documents-fields-schema-design.html +overview-of-searching-in-solr.html;searching-in-solr.html +query-settings-in-solrconfig.html;caches-warming.html +query-syntax-and-parsing.html;query-syntax-and-parsers.html +requestdispatcher-in-solrconfig.html;requestdispatcher.html +requesthandlers-and-searchcomponents-in-solrconfig.html;requesthandlers-searchcomponents.html +running-solr-on-hdfs.html;solr-on-hdfs.html +running-your-analyzer.html;analysis-screen.html +schema-factory-definition-in-solrconfig.html;schema-factory.html +searching.html;query-syntax-and-parsers.html +setting-up-an-external-zookeeper-ensemble.html;zookeeper-ensemble.html +shards-and-indexing-data-in-solrcloud.html;solrcloud-shards-indexing.html +solr-configuration-files.html;configuration-files.html +solr-jdbc-apache-zeppelin.html;jdbc-zeppelin.html +solr-jdbc-dbvisualizer.html;jdbc-dbvisualizer.html +solr-jdbc-python-jython.html;jdbc-python-jython.html +solr-jdbc-r.html;jdbc-r.html +solr-jdbc-squirrel-sql.html;jdbc-squirrel.html +solr-system-requirements.html;system-requirements.html +solr-tracing.html;distributed-tracing.html +the-dismax-query-parser.html;dismax-query-parser.html +the-extended-dismax-query-parser.html;edismax-query-parser.html +the-query-elevation-component.html;query-elevation-component.html +the-standard-query-parser.html;standard-query-parser.html +the-stats-component.html;stats-component.html +the-tagger-handler.html;tagger-handler.html +the-term-vector-component.html;term-vector-component.html +the-terms-component.html;terms-component.html +transforming-result-documents.html;document-transformers.html +understanding-analyzers-tokenizers-and-filters.html;document-analysis.html +updatehandlers-in-solrconfig.html;commits-transaction-logs.html +updating-parts-of-documents.html;partial-document-updates.html +uploading-data-with-index-handlers.html;indexing-with-update-handlers.html +uploading-data-with-solr-cell-using-apache-tika.html;indexing-with-tika.html +using-javascript.html;javascript.html +using-jmx-with-solr.html;jmx-with-solr.html +using-python.html;python.html +using-solr-from-ruby.html;ruby.html +using-solrj.html;solrj.html +using-the-solr-administration-user-interface.html;solr-admin-ui.html +using-zookeeper-to-manage-configuration-files.html;zookeeper-file-management.html +working-with-currencies-and-exchange-rates.html;currencies-exchange-rates.html +working-with-dates.html;date-formatting-math.html +working-with-enum-fields.html;enum-fields.html +working-with-external-files-and-processes.html;external-files-processes.html + +# Removed pages that should link to another page +about-filters.adoc;filters.adoc +about-tokenizers.adoc;tokenizers.adoc +choosing-an-output-format.html;client-apis.html +client-api-lineup.adoc;client-apis.html +collection-specific-tools.adoc;solr-admin-ui.adoc +combining-distribution-and-replication.adoc;user-managed-distributed-search.adoc +files-screen.adoc;configuration-files.adoc +core-specific-tools.adoc;solr-admin-ui.adoc +how-solrcloud-works.adoc;cluster-types.html#solrcloud-mode +introduction-to-client-apis.adoc;client-apis.adoc +java-properties.adoc;jvm-settings.adoc +logging.adoc;configuring-logging.adoc +merging-indexes.adoc;coreadmin-api.adoc +near-real-time-searching.adoc;commits-transaction-logs.adoc +overview-of-the-solr-admin-ui.adoc;solr-admin-ui.adoc +replication-screen.adoc;user-managed-index-replication.adoc +segments-info.adoc;index-segments-merging.adoc +solr-cores-and-solr-xml.adoc;core-discovery.adoc +solrcloud-query-routing-and-read-tolerance.adoc;solrcloud-distributed-requests.html +parameter-reference.adoc;configuring-solr-xml.html +getting-started.adoc;introduction.adoc +configuration-apis.adoc;config-api.html +documents-fields-and-schema-design.adoc;fields.html +further-assistance.adoc;https://solr.apache.org/community.html +legacy-scaling-and-distribution.adoc;cluster-types.html#user-managed-mode +introduction-to-scaling-and-distribution.adoc;cluster-types.html#user-managed-mode +monitoring-solr.adoc;configuring-logging.html +solr-field-types.adoc;field-type-definitions-and-properties.html +solrcloud-configuration-and-parameters.adoc;solrcloud-shards-indexing.html +solrcloud-resilience.adoc;solrcloud-recoveries-and-write-tolerance.html +the-well-configured-solr-instance.adoc;configuration-files.html +solrcloud.adoc;cluster-types.html#solrcloud-mode +how-to-contribute.adoc;https://solr.apache.org/community.html#how-to-contribute +deployment-and-operations.adoc;installing-solr.html + +# A bit uncertain of these +parallel-sql-interface.html;sql-query.html + +# Removed functionality, redirect to same page in 8.11 guide +cross-data-center-replication-cdcr.html;_8_11 +cdcr-api.html;_8_11 +cdcr-architecture.html;_8_11 +cdcr-config.html;_8_11 +cdcr-operations.html;_8_11 +dataimport-screen.html;_8_11 +adding-custom-plugins-in-solrcloud-mode.adoc;_8_11 +solrcloud-autoscaling-api.adoc;_8_11 +solrcloud-autoscaling-auto-add-replicas.adoc;_8_11 +solrcloud-autoscaling-fault-tolerance.adoc;_8_11 +solrcloud-autoscaling-listeners.adoc;_8_11 +solrcloud-autoscaling-overview.adoc;_8_11 +solrcloud-autoscaling-policy-preferences.adoc;_8_11 +solrcloud-autoscaling-trigger-actions.adoc;_8_11 +solrcloud-autoscaling-triggers.adoc;_8_11 +solrcloud-autoscaling.adoc;_8_11 +suggestions-screen.adoc;_8_11 +uploading-structured-data-store-data-with-the-data-import-handler.adoc;_8_11 +velocity-response-writer.adoc;_8_11 +velocity-search-ui.adoc;_8_11 +blob-store-api.html;_8_11 +colocating-collections.html;_8_11 +metrics-history.html;_8_11 +migrate-to-policy-rule.html;_8_11 +rule-based-replica-placement.html;_8_11 +putting-the-pieces-together.html;_8_11 +blockjoin-faceting.html;_8_11 +errata.html;_8_11 diff --git a/dev-tools/scripts/refguide/new-guide.txt b/dev-tools/scripts/refguide/new-guide.txt new file mode 100644 index 000000000000..5d6d96ed21a7 --- /dev/null +++ b/dev-tools/scripts/refguide/new-guide.txt @@ -0,0 +1,228 @@ +upgrade-notes/major-changes-in-solr-9.html +upgrade-notes/major-changes-in-solr-8.html +upgrade-notes/major-changes-in-solr-7.html +upgrade-notes/major-changes-in-solr-6.html +upgrade-notes/solr-upgrade-notes.html +deployment-guide/collection-management.html +deployment-guide/collections-core-admin.html +deployment-guide/solrj.html +deployment-guide/task-management.html +deployment-guide/python.html +deployment-guide/jvm-settings.html +deployment-guide/ping.html +deployment-guide/plugins-stats-screen.html +deployment-guide/jwt-authentication-plugin.html +deployment-guide/solrcloud-distributed-requests.html +deployment-guide/enabling-ssl.html +deployment-guide/solrcloud-recoveries-and-write-tolerance.html +deployment-guide/backup-restore.html +deployment-guide/security-ui.html +deployment-guide/zookeeper-file-management.html +deployment-guide/securing-solr.html +deployment-guide/performance-statistics-reference.html +deployment-guide/metrics-reporting.html +deployment-guide/javascript.html +deployment-guide/solrcloud-with-legacy-configuration-files.html +deployment-guide/user-managed-index-replication.html +deployment-guide/mbean-request-handler.html +deployment-guide/upgrading-a-solr-cluster.html +deployment-guide/basic-authentication-plugin.html +deployment-guide/cert-authentication-plugin.html +deployment-guide/taking-solr-to-production.html +deployment-guide/installing-solr.html +deployment-guide/indexupgrader-tool.html +deployment-guide/rate-limiters.html +deployment-guide/solrcloud-shards-indexing.html +deployment-guide/user-managed-distributed-search.html +deployment-guide/zookeeper-utilities.html +deployment-guide/docker-networking.html +deployment-guide/hadoop-authentication-plugin.html +deployment-guide/rule-based-authorization-plugin.html +deployment-guide/circuit-breakers.html +deployment-guide/configuring-logging.html +deployment-guide/distributed-tracing.html +deployment-guide/monitoring-with-prometheus-and-grafana.html +deployment-guide/alias-management.html +deployment-guide/thread-dump.html +deployment-guide/ruby.html +deployment-guide/cluster-types.html +deployment-guide/replica-management.html +deployment-guide/system-requirements.html +deployment-guide/client-apis.html +deployment-guide/jmx-with-solr.html +deployment-guide/aliases.html +deployment-guide/solr-on-hdfs.html +deployment-guide/solr-control-script-reference.html +deployment-guide/cloud-screens.html +deployment-guide/docker-faq.html +deployment-guide/node-roles.html +deployment-guide/shard-management.html +deployment-guide/authentication-and-authorization-plugins.html +deployment-guide/zookeeper-access-control.html +deployment-guide/zookeeper-ensemble.html +deployment-guide/solr-in-docker.html +deployment-guide/kerberos-authentication-plugin.html +deployment-guide/audit-logging.html +deployment-guide/cluster-node-management.html +query-guide/block-join-query-parser.html +query-guide/jdbc-r.html +query-guide/query-screen.html +query-guide/response-writers.html +query-guide/exporting-result-sets.html +query-guide/morelikethis.html +query-guide/faceting.html +query-guide/standard-query-parser.html +query-guide/analytics-expression-sources.html +query-guide/transform.html +query-guide/variables.html +query-guide/json-request-api.html +query-guide/computational-geometry.html +query-guide/suggester.html +query-guide/matrix-math.html +query-guide/learning-to-rank.html +query-guide/sql-query.html +query-guide/graph.html +query-guide/json-faceting-domain-changes.html +query-guide/document-transformers.html +query-guide/machine-learning.html +query-guide/streaming-expressions.html +query-guide/jdbc-squirrel.html +query-guide/highlighting.html +query-guide/local-params.html +query-guide/common-query-parameters.html +query-guide/collapse-and-expand-results.html +query-guide/stream-api.html +query-guide/dsp.html +query-guide/stream-screen.html +query-guide/query-elevation-component.html +query-guide/jdbc-zeppelin.html +query-guide/statistics.html +query-guide/pagination-of-results.html +query-guide/curve-fitting.html +query-guide/math-start.html +query-guide/spatial-search.html +query-guide/result-clustering.html +query-guide/result-grouping.html +query-guide/stream-evaluator-reference.html +query-guide/search-sample.html +query-guide/scalar-math.html +query-guide/spell-checking.html +query-guide/stats-component.html +query-guide/stream-source-reference.html +query-guide/tagger-handler.html +query-guide/json-facet-api.html +query-guide/join-query-parser.html +query-guide/probability-distributions.html +query-guide/edismax-query-parser.html +query-guide/analytics-mapping-functions.html +query-guide/query-re-ranking.html +query-guide/term-vector-component.html +query-guide/visualization.html +query-guide/loading.html +query-guide/analytics.html +query-guide/vector-math.html +query-guide/logs.html +query-guide/function-queries.html +query-guide/math-expressions.html +query-guide/numerical-analysis.html +query-guide/simulations.html +query-guide/term-vectors.html +query-guide/terms-component.html +query-guide/graph-traversal.html +query-guide/jdbc-dbvisualizer.html +query-guide/time-series.html +query-guide/sql-screen.html +query-guide/dismax-query-parser.html +query-guide/searching-nested-documents.html +query-guide/dense-vector-search.html +query-guide/regression.html +query-guide/analytics-reduction-functions.html +query-guide/other-parsers.html +query-guide/jdbc-python-jython.html +query-guide/json-query-dsl.html +query-guide/query-syntax-and-parsers.html +query-guide/stream-decorator-reference.html +getting-started/relevance.html +getting-started/solr-glossary.html +getting-started/solr-indexing.html +getting-started/searching-in-solr.html +getting-started/tutorial-aws.html +getting-started/about-this-guide.html +getting-started/solr-tutorial.html +getting-started/tutorial-techproducts.html +getting-started/solr-admin-ui.html +getting-started/tutorial-diy.html +getting-started/introduction.html +getting-started/documents-fields-schema-design.html +getting-started/tutorial-solrcloud.html +getting-started/tutorial-films.html +configuration-guide/realtime-get.html +configuration-guide/core-discovery.html +configuration-guide/configuring-solrconfig-xml.html +configuration-guide/configsets-api.html +configuration-guide/requestdispatcher.html +configuration-guide/config-api.html +configuration-guide/configuration-files.html +configuration-guide/index-segments-merging.html +configuration-guide/solr-modules.html +configuration-guide/package-manager-internals.html +configuration-guide/property-substitution.html +configuration-guide/implicit-requesthandlers.html +configuration-guide/package-manager.html +configuration-guide/replica-placement-plugins.html +configuration-guide/initparams.html +configuration-guide/solr-plugins.html +configuration-guide/config-sets.html +configuration-guide/schema-factory.html +configuration-guide/caches-warming.html +configuration-guide/coreadmin-api.html +configuration-guide/requesthandlers-searchcomponents.html +configuration-guide/update-request-processors.html +configuration-guide/configuring-solr-xml.html +configuration-guide/v2-api.html +configuration-guide/script-update-processor.html +configuration-guide/codec-factory.html +configuration-guide/index-location-format.html +configuration-guide/collections-api.html +configuration-guide/resource-loading.html +configuration-guide/request-parameters-api.html +configuration-guide/cluster-plugins.html +configuration-guide/managed-resources.html +configuration-guide/commits-transaction-logs.html +configuration-guide/libs.html +indexing-guide/schema-designer.html +indexing-guide/reindexing.html +indexing-guide/field-properties-by-use-case.html +indexing-guide/analysis-screen.html +indexing-guide/enum-fields.html +indexing-guide/de-duplication.html +indexing-guide/filters.html +indexing-guide/partial-document-updates.html +indexing-guide/schema-browser-screen.html +indexing-guide/content-streams.html +indexing-guide/transforming-and-indexing-custom-json.html +indexing-guide/date-formatting-math.html +indexing-guide/currencies-exchange-rates.html +indexing-guide/docvalues.html +indexing-guide/fields.html +indexing-guide/field-types-included-with-solr.html +indexing-guide/luke-request-handler.html +indexing-guide/external-files-processes.html +indexing-guide/language-detection.html +indexing-guide/tokenizers.html +indexing-guide/analyzers.html +indexing-guide/post-tool.html +indexing-guide/indexing-with-update-handlers.html +indexing-guide/charfilterfactories.html +indexing-guide/dynamic-fields.html +indexing-guide/phonetic-matching.html +indexing-guide/schema-elements.html +indexing-guide/field-type-definitions-and-properties.html +indexing-guide/language-analysis.html +indexing-guide/documents-screen.html +indexing-guide/copy-fields.html +indexing-guide/indexing-with-tika.html +indexing-guide/document-analysis.html +indexing-guide/schemaless-mode.html +indexing-guide/indexing-nested-documents.html +indexing-guide/schema-api.html \ No newline at end of file diff --git a/dev-tools/scripts/refguide/old-guide.txt b/dev-tools/scripts/refguide/old-guide.txt new file mode 100644 index 000000000000..94da07939574 --- /dev/null +++ b/dev-tools/scripts/refguide/old-guide.txt @@ -0,0 +1,271 @@ +a-quick-overview.adoc +about-filters.adoc +about-this-guide.adoc +about-tokenizers.adoc +adding-custom-plugins-in-solrcloud-mode.adoc +aliases.adoc +analysis-screen.adoc +analytics-expression-sources.adoc +analytics-mapping-functions.adoc +analytics-reduction-functions.adoc +analytics.adoc +analyzers.adoc +audit-logging.adoc +authentication-and-authorization-plugins.adoc +aws-solrcloud-tutorial.adoc +basic-authentication-plugin.adoc +blob-store-api.adoc +blockjoin-faceting.adoc +cdcr-api.adoc +cdcr-architecture.adoc +cdcr-config.adoc +cdcr-operations.adoc +charfilterfactories.adoc +choosing-an-output-format.adoc +circuit-breakers.adoc +client-api-lineup.adoc +client-apis.adoc +cloud-screens.adoc +cluster-node-management.adoc +codec-factory.adoc +collapse-and-expand-results.adoc +collection-aliasing.adoc +collection-management.adoc +collection-specific-tools.adoc +collections-api.adoc +collections-core-admin.adoc +colocating-collections.adoc +combining-distribution-and-replication.adoc +command-line-utilities.adoc +common-query-parameters.adoc +computational-geometry.adoc +config-api.adoc +config-sets.adoc +configsets-api.adoc +configuration-apis.adoc +configuring-logging.adoc +configuring-solrconfig-xml.adoc +content-streams.adoc +copying-fields.adoc +core-specific-tools.adoc +coreadmin-api.adoc +cross-data-center-replication-cdcr.adoc +curve-fitting.adoc +datadir-and-directoryfactory-in-solrconfig.adoc +dataimport-screen.adoc +de-duplication.adoc +defining-core-properties.adoc +defining-fields.adoc +deployment-and-operations.adoc +detecting-languages-during-indexing.adoc +distributed-requests.adoc +distributed-search-with-index-sharding.adoc +documents-fields-and-schema-design.adoc +documents-screen.adoc +docvalues.adoc +dsp.adoc +dynamic-fields.adoc +enabling-ssl.adoc +errata.adoc +exporting-result-sets.adoc +faceting.adoc +field-properties-by-use-case.adoc +field-type-definitions-and-properties.adoc +field-types-included-with-solr.adoc +files-screen.adoc +filter-descriptions.adoc +format-of-solr-xml.adoc +function-queries.adoc +further-assistance.adoc +getting-started-with-solrcloud.adoc +getting-started.adoc +graph-traversal.adoc +graph.adoc +hadoop-authentication-plugin.adoc +highlighting.adoc +how-solrcloud-works.adoc +how-to-contribute.adoc +implicit-requesthandlers.adoc +index-replication.adoc +indexconfig-in-solrconfig.adoc +indexing-and-basic-data-operations.adoc +indexing-nested-documents.adoc +indexupgrader-tool.adoc +initparams-in-solrconfig.adoc +installing-solr.adoc +introduction-to-client-apis.adoc +introduction-to-scaling-and-distribution.adoc +introduction-to-solr-indexing.adoc +java-properties.adoc +json-facet-api.adoc +json-faceting-domain-changes.adoc +json-query-dsl.adoc +json-request-api.adoc +jvm-settings.adoc +jwt-authentication-plugin.adoc +kerberos-authentication-plugin.adoc +language-analysis.adoc +learning-to-rank.adoc +legacy-scaling-and-distribution.adoc +libs.adoc +loading.adoc +local-parameters-in-queries.adoc +logging.adoc +logs.adoc +luke-request-handler.adoc +machine-learning.adoc +major-changes-from-solr-5-to-solr-6.adoc +major-changes-in-solr-7.adoc +major-changes-in-solr-8.adoc +making-and-restoring-backups.adoc +managed-resources.adoc +math-expressions.adoc +math-start.adoc +matrix-math.adoc +mbean-request-handler.adoc +merging-indexes.adoc +metrics-history.adoc +metrics-reporting.adoc +migrate-to-policy-rule.adoc +monitoring-solr-with-prometheus-and-grafana.adoc +monitoring-solr.adoc +morelikethis.adoc +near-real-time-searching.adoc +numerical-analysis.adoc +other-parsers.adoc +other-schema-elements.adoc +overview-of-documents-fields-and-schema-design.adoc +overview-of-searching-in-solr.adoc +overview-of-the-solr-admin-ui.adoc +package-manager-internals.adoc +package-manager.adoc +pagination-of-results.adoc +parallel-sql-interface.adoc +parameter-reference.adoc +performance-statistics-reference.adoc +phonetic-matching.adoc +ping.adoc +plugins-stats-screen.adoc +post-tool.adoc +probability-distributions.adoc +putting-the-pieces-together.adoc +query-re-ranking.adoc +query-screen.adoc +query-settings-in-solrconfig.adoc +query-syntax-and-parsing.adoc +realtime-get.adoc +regression.adoc +reindexing.adoc +relevance.adoc +replica-management.adoc +replication-screen.adoc +request-parameters-api.adoc +requestdispatcher-in-solrconfig.adoc +requesthandlers-and-searchcomponents-in-solrconfig.adoc +resource-loading.adoc +response-writers.adoc +result-grouping.adoc +rule-based-authorization-plugin.adoc +rule-based-replica-placement.adoc +running-solr-on-hdfs.adoc +running-your-analyzer.adoc +scalar-math.adoc +schema-api.adoc +schema-browser-screen.adoc +schema-designer.adoc +schema-factory-definition-in-solrconfig.adoc +schemaless-mode.adoc +search-sample.adoc +searching-nested-documents.adoc +searching.adoc +securing-solr.adoc +security-ui.adoc +segments-info.adoc +setting-up-an-external-zookeeper-ensemble.adoc +shard-management.adoc +shards-and-indexing-data-in-solrcloud.adoc +simulations.adoc +solr-configuration-files.adoc +solr-control-script-reference.adoc +solr-cores-and-solr-xml.adoc +solr-field-types.adoc +solr-glossary.adoc +solr-jdbc-apache-zeppelin.adoc +solr-jdbc-dbvisualizer.adoc +solr-jdbc-python-jython.adoc +solr-jdbc-r.adoc +solr-jdbc-squirrel-sql.adoc +solr-plugins.adoc +solr-system-requirements.adoc +solr-tracing.adoc +solr-tutorial.adoc +solr-upgrade-notes.adoc +solrcloud-autoscaling-api.adoc +solrcloud-autoscaling-auto-add-replicas.adoc +solrcloud-autoscaling-fault-tolerance.adoc +solrcloud-autoscaling-listeners.adoc +solrcloud-autoscaling-overview.adoc +solrcloud-autoscaling-policy-preferences.adoc +solrcloud-autoscaling-trigger-actions.adoc +solrcloud-autoscaling-triggers.adoc +solrcloud-autoscaling.adoc +solrcloud-configuration-and-parameters.adoc +solrcloud-query-routing-and-read-tolerance.adoc +solrcloud-recoveries-and-write-tolerance.adoc +solrcloud-resilience.adoc +solrcloud-with-legacy-configuration-files.adoc +solrcloud.adoc +spatial-search.adoc +spell-checking.adoc +statistics.adoc +stream-api.adoc +stream-decorator-reference.adoc +stream-evaluator-reference.adoc +stream-screen.adoc +stream-source-reference.adoc +streaming-expressions.adoc +suggester.adoc +suggestions-screen.adoc +taking-solr-to-production.adoc +term-vectors.adoc +the-dismax-query-parser.adoc +the-extended-dismax-query-parser.adoc +the-query-elevation-component.adoc +the-standard-query-parser.adoc +the-stats-component.adoc +the-tagger-handler.adoc +the-term-vector-component.adoc +the-terms-component.adoc +the-well-configured-solr-instance.adoc +thread-dump.adoc +time-series.adoc +tokenizers.adoc +transform.adoc +transforming-and-indexing-custom-json.adoc +transforming-result-documents.adoc +understanding-analyzers-tokenizers-and-filters.adoc +update-request-processors.adoc +updatehandlers-in-solrconfig.adoc +updating-parts-of-documents.adoc +upgrading-a-solr-cluster.adoc +uploading-data-with-index-handlers.adoc +uploading-data-with-solr-cell-using-apache-tika.adoc +uploading-structured-data-store-data-with-the-data-import-handler.adoc +using-javascript.adoc +using-jmx-with-solr.adoc +using-python.adoc +using-solr-from-ruby.adoc +using-solrj.adoc +using-the-solr-administration-user-interface.adoc +using-zookeeper-to-manage-configuration-files.adoc +v2-api.adoc +variables.adoc +vector-math.adoc +velocity-response-writer.adoc +velocity-search-ui.adoc +visualization.adoc +working-with-currencies-and-exchange-rates.adoc +working-with-dates.adoc +working-with-enum-fields.adoc +working-with-external-files-and-processes.adoc +zookeeper-access-control.adoc \ No newline at end of file diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc index 920e9a3d1037..17f128d1857b 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc @@ -18,9 +18,11 @@ // under the License. Installation of Solr on Unix-compatible or Windows servers generally requires simply extracting (or, unzipping) the download package. - Please be sure to review the xref:system-requirements.adoc[] before starting Solr. +Solr can also be xref:solr-in-docker.adoc[installed and deployed in Docker]. +The official image uses the binary release directly, so the xref:#directory-layout[directory layout] will be identical to what is described below. + == Available Solr Packages Solr is available from the Solr website. diff --git a/solr/solr-ref-guide/src/old-pages/configuration-apis.adoc b/solr/solr-ref-guide/src/old-pages/configuration-apis.adoc deleted file mode 100644 index ef11bcf51f40..000000000000 --- a/solr/solr-ref-guide/src/old-pages/configuration-apis.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= Configuration APIs -:page-children: config-api, \ - request-parameters-api, \ - managed-resources, \ - collections-api, \ - configsets-api, \ - coreadmin-api, \ - v2-api -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may ouildbtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -Solr includes several APIs that can be used to modify settings in `solrconfig.xml`. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::configapi-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Configure `solrconfig.xml`. -| <>: Override parameters in `solrconfig.xml`. -| <>: Programmatic control over resource files. -| <>: Manage SolrCloud from cores to nodes. -| <>: Manage configsets. -| <>: Manage Cores. -| <>: The v2 API structure. -| -|=== -// end::configapi-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/configuration-guide.adoc b/solr/solr-ref-guide/src/old-pages/configuration-guide.adoc deleted file mode 100644 index d0c4e129998b..000000000000 --- a/solr/solr-ref-guide/src/old-pages/configuration-guide.adoc +++ /dev/null @@ -1,74 +0,0 @@ -= Configuration Guide -:page-children: configuration-files, \ - property-substitution, \ - core-discovery, \ - configuring-solr-xml, \ - configuring-solrconfig-xml, \ - configuration-apis, \ - config-sets, \ - resource-loading, \ - solr-plugins -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This section covers configuration files and options for customizing your Solr installation. - -**** -[discrete] -=== Configuration Overview - -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Solr's major configuration files. -| <>: Provide property values at startup or in shared property files. -| <>: Placement of `core.properties` and available property options. -| <>: Use configsets to avoid duplicating effort when defining a new core. -| <>: Resolving word lists, model files, and related data. -| <>: Global configuration options. -|=== -**** - -**** -[discrete] -=== solrconfig.xml - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::configuring-solrconfig-xml.adoc[tag=solrconfig-sections] -**** - -**** -[discrete] -=== Configuration APIs - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::configuration-apis.adoc[tag=configapi-sections] -**** - -**** -[discrete] -=== Solr Plugins - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::solr-plugins.adoc[tag=plugin-sections] -**** diff --git a/solr/solr-ref-guide/src/old-pages/controlling-results.adoc b/solr/solr-ref-guide/src/old-pages/controlling-results.adoc deleted file mode 100644 index 9e623265bf36..000000000000 --- a/solr/solr-ref-guide/src/old-pages/controlling-results.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= Controlling Results -:page-children: faceting, \ - json-facet-api, \ - collapse-and-expand-results, \ - result-grouping, \ - result-clustering, \ - highlighting, \ - query-elevation-component, \ - document-transformers, \ - response-writers, \ - exporting-result-sets, \ - pagination-of-results -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -Once users submit a query, Solr provides a number of options for how to present the results. - -Features like facets, grouping, collapsing, and clustering provide ways to group similar results together. - -Highlighting shows users their query terms in context with surrounding text, helping them decide if a document "matches" their query. - -Solr offers several ways to get results, or control how "pages" of results are returned to your client. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::results-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Categorize search results based on indexed terms. -| <>: JSON Facet API. -| <>: Collapse documents into groups and expand the results. -| <>: Group results based on common field values. -| <>: Group search results based on cluster analysis applied to text fields. -| <>: Highlighting search terms in document snippets. -| <>: Force documents to the top of the results for certain queries. -| <>: Compute information and add to individual documents. -| <>: Format options for search results. -| <>: Export large result sets out of Solr. -| <>: Offering paginated results. -| -|=== -// end::results-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/deployment-guide.adoc b/solr/solr-ref-guide/src/old-pages/deployment-guide.adoc deleted file mode 100644 index 3fcfcf8e6c69..000000000000 --- a/solr/solr-ref-guide/src/old-pages/deployment-guide.adoc +++ /dev/null @@ -1,100 +0,0 @@ -= Deployment Guide -:page-children: solr-control-script-reference, \ - installation-deployment, \ - scaling-solr, \ - monitoring-solr, \ - securing-solr, \ - client-apis -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -The Deployment Guide covers installation, upgrades, deployments, monitoring, and client integrations. - -**** -[discrete] -=== Solr CLI - -<>: The options available to the `bin/solr` or `bin\solr.cmd` scripts. -**** - -**** -[discrete] -=== Installation & Deployment - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::installation-deployment.adoc[tag=install-sections] -**** - -**** -[discrete] -=== Scaling Solr - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::scaling-solr.adoc[tag=scaling-sections] -**** - -**** -[discrete] -=== Monitoring Solr - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::monitoring-solr.adoc[tag=monitoring-sections] -**** - -**** -[discrete] -=== Securing Solr - -<> - -Authentication Plugins: - -// This pulls the sub-section list from the child page to reduce errors -include::securing-solr.adoc[tag=list-of-authentication-plugins] - -Authorization Plugins: - -// This pulls the sub-section list from the child page to reduce errors -include::securing-solr.adoc[tag=list-of-authorization-plugins] - -Audit Logging and SSL: - -[width=100%,cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <> -| <> -| <> -| -|=== -**** - -**** -[discrete] -=== Client APIs - -<>: Access Solr through various client APIs, including JavaScript, JSON, and Ruby. - -// This pulls the sub-section list from the child page to reduce errors -include::client-apis.adoc[tag=client-sections] -**** diff --git a/solr/solr-ref-guide/src/old-pages/enhancing-queries.adoc b/solr/solr-ref-guide/src/old-pages/enhancing-queries.adoc deleted file mode 100644 index 7d34db18ec43..000000000000 --- a/solr/solr-ref-guide/src/old-pages/enhancing-queries.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= Enhancing Queries -:page-children: spell-checking, \ - suggester, \ - morelikethis, \ - query-re-ranking, \ - learning-to-rank, \ - tagger-handler, \ - analytics, \ - terms-component, \ - term-vector-component, \ - stats-component -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -Solr provides many options for assisting users with their queries. - -These options allow you to show users alternate spellings for their search terms, or provide suggestions for terms while they type. - -Re-ranking provides an ability to show documents in an order based on a query that may be more complex than the user's query. -This forms the basis of Solr's Learning to Rank functionality, which can re-rank documents based on a machine-learned model. - -The Tagger request handler provides basic named entity recognition functionality. - -Finally, if you want to understand the terms in your index or get statistics from terms in the index, those options are covered here also. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::queries-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Check user spelling of query terms. -| <>: Suggest query terms while the user types. -| <>: Get results similar to result documents. -| <>: Re-rank top documents. -| <>: Use machine learned ranking models. -| <>: Basic named entity tagging in text. -| <>: Compute complex analytics over a result set. -| <>: Access indexed terms and the documents that include them. -| <>: Term information about specific documents. -| <>: Get information from numeric fields within a document set. -|=== -// end::queries-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/field-types.adoc b/solr/solr-ref-guide/src/old-pages/field-types.adoc deleted file mode 100644 index 985ae9107f5b..000000000000 --- a/solr/solr-ref-guide/src/old-pages/field-types.adoc +++ /dev/null @@ -1,44 +0,0 @@ -= Field Types -:page-children: field-type-definitions-and-properties, \ - field-types-included-with-solr, \ - currencies-exchange-rates, \ - date-formatting-math, \ - enum-fields, \ - external-files-processes, \ - field-properties-by-use-case -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -The field type defines how Solr should interpret data in a field and how the field can be queried. -There are many field types included with Solr by default, and they can also be defined locally. - -**** - -[%autowidth.stretch,cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <> -| <> -| <> -| <> -| <> -| <> -| <> -| -|=== - -**** diff --git a/solr/solr-ref-guide/src/old-pages/fields-and-schema-design.adoc b/solr/solr-ref-guide/src/old-pages/fields-and-schema-design.adoc deleted file mode 100644 index 0bbf641a8a0f..000000000000 --- a/solr/solr-ref-guide/src/old-pages/fields-and-schema-design.adoc +++ /dev/null @@ -1,42 +0,0 @@ -= Fields and Schema Design -:page-children: fields, \ - field-types, \ - copy-fields, \ - dynamic-fields, \ - docvalues, \ - luke-request-handler -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -This section discusses how Solr organizes its data into documents and fields, as well as how to work with a schema in Solr. - -This section includes the following topics: - -**** -// This tags the below list so it can be used in the parent page section list -// tag::fields-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Fields in Solr. -| <>: Field types in Solr, including the field types in the default Solr schema. -| <>: Fields with data copied from another field. -| <>: Fields that inherit field type properties at index time. -| <>: DocValues indexes for faster lookups. -| <>: Provides access to information about fields in the index. -|=== -// end::fields-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/getting-started.adoc b/solr/solr-ref-guide/src/old-pages/getting-started.adoc deleted file mode 100644 index a88c76db3c1d..000000000000 --- a/solr/solr-ref-guide/src/old-pages/getting-started.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= Getting Started -:page-children: introduction, \ - solr-concepts, \ - solr-tutorial, \ - solr-admin-ui, \ - about-this-guide -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -Solr makes it easy for programmers to develop sophisticated, high-performance search applications with advanced features. - -This section introduces you to the basic Solr architecture and features to help you get up and running quickly. -It covers the following topics: - -**** -<>: Short introduction to Solr's primary features. -**** - -**** -<>: Beginner information on Solr and information retrieval concepts. - -// This pulls the sub-section list from the child page to reduce errors -include::solr-concepts.adoc[tag=concept-sections] -**** - -**** -<>: A multi-exercise tutorial that covers the main concepts of indexing and querying Solr. -**** - -**** -<>: Solr's Web-based interface for administering Solr. -**** - -**** -<>: How to use this Reference Guide. -**** diff --git a/solr/solr-ref-guide/src/old-pages/indexing-data-operations.adoc b/solr/solr-ref-guide/src/old-pages/indexing-data-operations.adoc deleted file mode 100644 index e33fe91209d7..000000000000 --- a/solr/solr-ref-guide/src/old-pages/indexing-data-operations.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= Indexing and Data Operations -:page-children: indexing-with-update-handlers, \ - indexing-with-tika, \ - indexing-nested-documents, \ - post-tool, \ - documents-screen, \ - partial-document-updates, \ - reindexing, \ - language-detection, \ - de-duplication, \ - content-streams -:page-show-toc: false -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -This section describes how Solr adds data to its index. -It covers the following topics: - -**** -// This tags the below list so it can be used in the parent page section list -// tag::indexing-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Index XML/XSLT, JSON and CSV data. -| <>: Use Tika to index data. -| <>: Index custom JSON data. -| <>: Indexing and schema configuration for nested documents. -| <>: Quickly upload content to your system. -| <>: Admin UI for form-based document updates. -| <>: Atomic updates and optimistic concurrency. -| <>: When and how to reindex. -| <>: Language identification during indexing. -| <>: Mark duplicate documents as they are indexed. -| <>: Stream content to request handlers. -| -|=== -// end::indexing-sections[] -**** - -== Indexing Using Client APIs - -Using client APIs, such as <>, from your applications is an important option for updating Solr indexes. -See the <> section for more information. diff --git a/solr/solr-ref-guide/src/old-pages/installation-deployment.adoc b/solr/solr-ref-guide/src/old-pages/installation-deployment.adoc deleted file mode 100644 index 93a4811e8517..000000000000 --- a/solr/solr-ref-guide/src/old-pages/installation-deployment.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= Installation and Deployment -:page-children: system-requirements, \ - installing-solr, \ - taking-solr-to-production, \ - jvm-settings, \ - upgrading-a-solr-cluster, \ - backup-restore, \ - solr-in-docker, \ - solr-on-hdfs -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This section covers system requirements, installation, upgrades, and deployments. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::install-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Solr system requirements. -| <>: Solr installation process. -| <>: Solr as a service and production considerations. -| <>: Java Virtual Machines best practices. -| <>: SolrCloud cluster upgrades. -| <>: Solr backup strategies. -| <>: Solr's Docker image. -| <>: Store Solr indexes and transaction logs in HDFS. -|=== -// end::install-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/monitoring-solr.adoc b/solr/solr-ref-guide/src/old-pages/monitoring-solr.adoc deleted file mode 100644 index f3af4f9700de..000000000000 --- a/solr/solr-ref-guide/src/old-pages/monitoring-solr.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= Monitoring Solr -:page-children: configuring-logging, \ - ping, \ - metrics-reporting, \ - performance-statistics-reference, \ - plugins-stats-screen, \ - mbean-request-handler, \ - monitoring-with-prometheus-and-grafana, \ - jmx-with-solr, \ - thread-dump, \ - distributed-tracing, \ - circuit-breakers, \ - rate-limiters, \ - task-management -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This section covers tools and approaches for monitoring Solr via the web-based administration UI, the command line interface, or REST APIs. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::monitoring-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Log levels and logging slow queries. -| <>: Ping a named core to determine whether it is active. -| <>: Metrics registries and Metrics API. -| <>: Statistics returned from JMX. -| <>: Admin UI for handler and component statistics. -| <>: MBeans for programmatic access to system plugins and stats. -| <>: Monitor Solr with Prometheus and Grafana. -| <>: Java Management Extensions and Solr. -| <>: Admin UI for information about each thread. -| <>: Distributed tracing for Solr requests. -| <>: Limit loads based on Java heap usage or CPU utilization. -| <> Limit concurrent requests by type. -| <> Control running tasks. -| -|=== -// end::monitoring-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/query-guide.adoc b/solr/solr-ref-guide/src/old-pages/query-guide.adoc deleted file mode 100644 index 404c45939248..000000000000 --- a/solr/solr-ref-guide/src/old-pages/query-guide.adoc +++ /dev/null @@ -1,72 +0,0 @@ -= Query Guide -:page-children: query-syntax-and-parsers, \ - enhancing-queries, \ - controlling-results, \ - streaming-expressions -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This section describes options to control how Solr works with user input and returns results for queries. - -It covers the following topics: - -**** -[discrete] -=== Query Syntax and Parsers - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::query-syntax-and-parsers.adoc[tag=parser-sections] -**** - -**** -[discrete] -=== Enhancing Queries -<> - -// This pulls the sub-section list from the child page to reduce errors -include::enhancing-queries.adoc[tag=queries-sections] -**** - -**** -[discrete] -=== Controlling Results -<> - -// This pulls the sub-section list from the child page to reduce errors -include::controlling-results.adoc[tag=results-sections] -**** - -**** -[discrete] -=== Streaming Expressions -<> - -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Stream sources. -| <>: Stream decorators. -| <>: Stream evaluators. -| <>: Streaming expressions for math and analytics applications. -| <>: Graph queries using streaming expressions. -| <>: REST API for expression plugins and daemon control. -| <>: Admin UI screen for streaming expressions. -| -|=== -**** diff --git a/solr/solr-ref-guide/src/old-pages/scaling-solr.adoc b/solr/solr-ref-guide/src/old-pages/scaling-solr.adoc deleted file mode 100644 index 491d8c528e20..000000000000 --- a/solr/solr-ref-guide/src/old-pages/scaling-solr.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= Scaling Solr -:page-children: cluster-types, \ - user-managed-clusters, \ - solrcloud-clusters -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -Solr supports large implementations by providing two distinct options for multi-node clusters. - -The section *<>* describes the two main approaches available for scaling. - -Both approaches share the ability to distribute parts of an index across multiple servers, a process called _sharding_. -This allows for an index that is larger than any one server can host and maintain reasonable performance. - -A second process called _replication_ is also shared by both approaches. -This allows for copying the index (in whole or as shards) across multiple servers, and provides query volume distribution. - -The differences between the approaches are then how each cluster is managed and what features are available to you. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::scaling-sections[] -[discrete] -==== User-Managed Clusters - -include::user-managed-clusters.adoc[tag=user-managed-sections] - -[discrete] -==== SolrCloud Clusters - -include::solrcloud-clusters.adoc[tag=solrcloud-sections] - -// end::scaling-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/schema-indexing-guide.adoc b/solr/solr-ref-guide/src/old-pages/schema-indexing-guide.adoc deleted file mode 100644 index 0e6450444d85..000000000000 --- a/solr/solr-ref-guide/src/old-pages/schema-indexing-guide.adoc +++ /dev/null @@ -1,63 +0,0 @@ -= Schema and Indexing Guide -:page-children: solr-schema, \ - fields-and-schema-design, \ - document-analysis, \ - indexing-data-operations -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This Guide covers indexing documents in Solr. - -**** -[discrete] -=== Solr's Schema - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::solr-schema.adoc[tag=schema-sections] -**** - -**** -[discrete] -=== Fields and Schema Design - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::fields-and-schema-design.adoc[tag=fields-sections] -**** - -**** -[discrete] -=== Document Analysis - -<> - -// This pulls the sub-section list from the child page to reduce errors -include::document-analysis.adoc[tag=analysis-sections] -**** - -**** -[discrete] -=== Indexing and Data Operations -<> - -// This pulls the sub-section list from the child page to reduce errors -include::indexing-data-operations.adoc[tag=indexing-sections] -**** diff --git a/solr/solr-ref-guide/src/old-pages/solr-concepts.adoc b/solr/solr-ref-guide/src/old-pages/solr-concepts.adoc deleted file mode 100644 index 3daddd5ec09a..000000000000 --- a/solr/solr-ref-guide/src/old-pages/solr-concepts.adoc +++ /dev/null @@ -1,40 +0,0 @@ -= Solr Concepts -:page-children: documents-fields-schema-design, \ - solr-indexing, \ - searching-in-solr, \ - relevance, \ - solr-glossary -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -This section covers essential information retrieval concepts and an introduction to how they are implemented in Solr. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::concept-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: An introduction to how Solr breaks documents into fields. -| <>: The process of adding documents or other data to Solr for later searching. -| <>: The basic building blocks of asking Solr questions. -| <>: A beginner's guide to understanding what relevance means in the search context. -| <>: Commonly used Solr terminology. -| -|=== -// end::concept-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/solr-schema.adoc b/solr/solr-ref-guide/src/old-pages/solr-schema.adoc deleted file mode 100644 index 7124d4fd4f40..000000000000 --- a/solr/solr-ref-guide/src/old-pages/solr-schema.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= Solr Schema -:page-children: schema-elements, \ - schema-api, \ - schemaless-mode, \ - schema-browser-screen, \ - schema-designer -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -Solr's schema governs how documents are indexed and how terms in a query are interpreted. - -The following sections cover how to work with the schema generally. -Note, however, that many of the elements of a schema are covered in the section <>. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::schema-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: The structure of Solr's schema. -| <>: An API to read a schema or create new fields and copyField rules. -| <>: Automatically add previously unknown fields using field type guessing. -| <>: Interactively create a schema using sample data. -| <>: Schema details through the Admin UI. -| -|=== -// end::schema-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/solrcloud-clusters.adoc b/solr/solr-ref-guide/src/old-pages/solrcloud-clusters.adoc deleted file mode 100644 index 03723f5fe933..000000000000 --- a/solr/solr-ref-guide/src/old-pages/solrcloud-clusters.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= SolrCloud Clusters -:page-children: solrcloud-shards-indexing, \ - solrcloud-recoveries-and-write-tolerance, \ - solrcloud-distributed-requests, \ - aliases, \ - node-roles, \ - cluster-node-management, \ - shard-management, \ - replica-management, \ - collection-management, \ - alias-management, \ - zookeeper-ensemble, \ - zookeeper-file-management, \ - zookeeper-utilities, \ - solrcloud-with-legacy-configuration-files, \ - collections-core-admin, \ - cloud-screens -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -SolrCloud is Solr's solution for fault tolerant and high availability clusters. -It provides central coordination of cluster activities and configurations and automatic load balancing and failover. - -ZooKeeper is a critical component of SolrCloud, used to manage shard and replica locations, as well as document and query routing. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::solrcloud-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -2+^h| Functionality Overview -| <>: Leaders and replica types, and routing documents during indexing. -| <>: Recovery in a SolrCloud cluster. -| <>: Query routing in a SolrCloud cluster. -| <>: Alternative names for collections. -2+^h| Cluster Management -| <>: Functional roles for nodes for multi-tiered clusters. -| -2+^h| Collections API -|<>: Cluster management commands of the Collections API. -| <>: Shard management commands of the Collections API. -| <>: Replica management commands of the Collections API. -|<>: Collection management commands of the Collections API. -|<>: Alias management commands of the Collections API. -| -2+^h| ZooKeeper Configuration -|<>: External ZooKeeper configuration. -| <>: Uploading files to ZooKeeper. -| <>: ZooKeeper CLI. -| <>: Migration from user-managed clusters to SolrCloud. -2+^h| Admin UI -| <>: Admin UI for collections and cores. -| <>: Admin UI for SolrCloud status and ZooKeeper files. -|=== -// end::solrcloud-sections[] -**** diff --git a/solr/solr-ref-guide/src/old-pages/user-managed-clusters.adoc b/solr/solr-ref-guide/src/old-pages/user-managed-clusters.adoc deleted file mode 100644 index affcb452d80a..000000000000 --- a/solr/solr-ref-guide/src/old-pages/user-managed-clusters.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= User-Managed Clusters -:page-children: user-managed-index-replication, \ - user-managed-distributed-search -// Licensed to the Apache Software Foundation (ASF) under one -// or more contributor license agreements. See the NOTICE file -// distributed with this work for additional information -// regarding copyright ownership. The ASF licenses this file -// to you under the Apache License, Version 2.0 (the -// "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -[.lead] -User-managed clusters provide flexibility for local control over cluster activities, without ZooKeeper to coordinate them. - -This flexibility means that you are responsible for core management, document and query routing, failover, and load balancing. - -**** -// This tags the below list so it can be used in the parent page section list -// tag::user-managed-sections[] -[cols="1,1",frame=none,grid=none,stripes=none] -|=== -| <>: Replicating indexes across nodes. -| <>: Distributed searching in a user-managed cluster. -|=== -// end::user-managed-sections[] -****