This is an automated email from the ASF dual-hosted git repository. ctargett pushed a commit to branch jira/solr-15556-antora in repository https://gitbox.apache.org/repos/asf/solr.git
commit 34b68bbff831b46b3294671162843fcf4a218d63 Author: Cassandra Targett <[email protected]> AuthorDate: Wed Nov 24 15:09:03 2021 -0600 Fix page refs in getting-started module & move 'pure nav' pages aside --- .../getting-started/getting-started-nav.adoc | 31 ++++++------ .../getting-started/pages/about-this-guide.adoc | 6 +-- .../pages/documents-fields-schema-design.adoc | 4 +- .../getting-started/pages/introduction.adoc | 8 ++-- .../getting-started/pages/searching-in-solr.adoc | 18 +++---- .../getting-started/pages/solr-admin-ui.adoc | 55 +++++++++++----------- .../getting-started/pages/solr-glossary.adoc | 24 +++++----- .../getting-started/pages/solr-indexing.adoc | 6 +-- .../getting-started/pages/solr-tutorial.adoc | 17 +++---- .../getting-started/pages/tutorial-aws.adoc | 12 ++--- .../getting-started/pages/tutorial-diy.adoc | 6 +-- .../getting-started/pages/tutorial-films.adoc | 2 +- .../getting-started/pages/tutorial-solrcloud.adoc | 18 +++---- .../pages/tutorial-techproducts.adoc | 12 ++--- .../pages => src/old-pages}/getting-started.adoc | 0 .../pages => src/old-pages}/solr-concepts.adoc | 0 16 files changed, 106 insertions(+), 113 deletions(-) diff --git a/solr/solr-ref-guide/modules/getting-started/getting-started-nav.adoc b/solr/solr-ref-guide/modules/getting-started/getting-started-nav.adoc index 64a59bd..b080246 100644 --- a/solr/solr-ref-guide/modules/getting-started/getting-started-nav.adoc +++ b/solr/solr-ref-guide/modules/getting-started/getting-started-nav.adoc @@ -1,20 +1,19 @@ .Getting Started -* xref:getting-started.adoc[] -** xref:introduction.adoc[] +* xref:introduction.adoc[] -** xref:solr-concepts.adoc[] -*** xref:documents-fields-schema-design.adoc[] -*** xref:solr-indexing.adoc[] -*** xref:searching-in-solr.adoc[] -*** xref:relevance.adoc[] -*** xref:solr-glossary.adoc[] +* Solr Concepts +** xref:documents-fields-schema-design.adoc[] +** xref:solr-indexing.adoc[] +** xref:searching-in-solr.adoc[] +** xref:relevance.adoc[] +** xref:solr-glossary.adoc[] -** xref:solr-tutorial.adoc[] -*** xref:tutorial-techproducts.adoc[] -*** xref:tutorial-films.adoc[] -*** xref:tutorial-diy.adoc[] -*** xref:tutorial-solrcloud.adoc[] -*** xref:tutorial-aws.adoc[] +* xref:solr-tutorial.adoc[] +** xref:tutorial-techproducts.adoc[] +** xref:tutorial-films.adoc[] +** xref:tutorial-diy.adoc[] +** xref:tutorial-solrcloud.adoc[] +** xref:tutorial-aws.adoc[] -** xref:solr-admin-ui.adoc[] -** xref:about-this-guide.adoc[] +* xref:solr-admin-ui.adoc[] +* xref:about-this-guide.adoc[] diff --git a/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc b/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc index e21f375..532fec2 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc @@ -33,7 +33,7 @@ The default port when running Solr is 8983. The samples, URLs and screenshots in this guide may show different ports, because the port number that Solr uses is configurable. If you have not customized your installation of Solr, please make sure that you use port 8983 when following the examples, or configure your own installation to use the port numbers shown in the examples. -For information about configuring port numbers, see the section <<monitoring-solr.adoc#,Monitoring Solr>>. +For information about configuring port numbers, see the section xref:deployment-guide:monitoring-solr.adoc[]. Similarly, URL examples use `localhost` throughout; if you are accessing Solr from a location remote to the server hosting Solr, replace `localhost` with the proper domain or IP where Solr is running. @@ -59,7 +59,7 @@ However, there can be exceptions, particularly if your installation has customiz In several cases of this Guide, our examples are built from the "techproducts" example (i.e., you have started Solr with the command `bin/solr -e techproducts`). In this case, `solr.home` will be a sub-directory of the `example/` directory created for you automatically. -See also the section <<configuration-files.adoc#solr-home,Solr Home>> for further details on what is contained in this directory. +See also the section xref:configuration-guide:configuration-files.adoc#solr-home[Solr Home] for further details on what is contained in this directory. == API Examples @@ -72,7 +72,7 @@ In all cases the paths and endpoints used are different. Throughout this Guide, we have added examples of both styles with sections labeled "V1 API" and "V2 API". As of the 7.2 version of this Guide, these examples are not yet complete - more coverage will be added as future versions of the Guide are released. -The section <<v2-api.adoc#,V2 API>> provides more information about how to work with the new API structure, including how to disable it if you choose to do so. +The section xref:configuration-guide:v2-api.adoc[] provides more information about how to work with the new API structure, including how to disable it if you choose to do so. All APIs return a response header that includes the status of the request and the time to process it. Some APIs will also include the parameters used for the request. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/documents-fields-schema-design.adoc b/solr/solr-ref-guide/modules/getting-started/pages/documents-fields-schema-design.adoc index 08c3443..bebda69 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/documents-fields-schema-design.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/documents-fields-schema-design.adoc @@ -77,7 +77,7 @@ For the biography field, you can tell Solr how to break apart the biography into You can tell Solr that you want to make all the words lower case, and you can tell Solr to remove accents marks. Field analysis is an important part of a field type. -<<document-analysis.adoc#,Document Analysis in Solr>> is a detailed description of field analysis. +xref:indexing-guide:document-analysis.adoc[] is a detailed description of field analysis. == Solr's Schema File @@ -98,4 +98,4 @@ If you aren't sure yet, plan on some test indexing runs to see how the data in y Build into your implementation plan some time for iteration and start small. The more you're able to define your schema before indexing all of your documents, the higher your chances for a successful search application for your users. -More information about the schema is in the section <<schema-elements.adoc#,Schema Elements>>. +More information about the schema is in the section xref:indexing-guide:schema-elements.adoc[]. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/introduction.adoc b/solr/solr-ref-guide/modules/getting-started/pages/introduction.adoc index 28fe32d..0700b7a 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/introduction.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/introduction.adoc @@ -23,20 +23,20 @@ Solr is based on open standards and it is highly extensible. Solr queries are simple HTTP request URLs and the response is a structured document: mainly JSON, but it could also be XML, CSV, or other formats. This means that a wide variety of clients will be able to use Solr, from other web applications to browser clients, rich client applications, and mobile devices. Any platform capable of HTTP can talk to Solr. -See <<client-apis.adoc#,Client APIs>> for details on client APIs. +See xref:deployment-guide:client-apis.adoc[] for details on client APIs. Flexible schema configurations allow nearly any type of data to be stored in Solr. -The <<schema-indexing-guide.adoc#,Schema and Indexing Guide>> has more details on these options. +The xref:indexing-guide:schema-indexing-guide.adoc[] has more details on these options. Solr offers support for the simplest keyword searching through to complex queries on multiple fields and faceted search results. Collapsing and clustering results offer compelling features for e-commerce and storefronts. Powerful math expressions provide the backbone for advanced analytics use cases. -The <<query-guide.adoc#,Query Guide>> has more information about searching and queries. +The xref:query-guide:query-guide.adoc[] has more information about searching and queries. If Solr's capabilities are not impressive enough, its ability to handle very high-volume applications should do the trick. A relatively common scenario is that you have so much data, or so many queries, that a single Solr server is unable to handle your entire workload. -In this case, you can scale up the capabilities of your application using <<scaling-solr.adoc#,SolrCloud>> to better distribute the data, and the processing of requests, across many servers. +In this case, you can scale up the capabilities of your application using xref:deployment-guide:cluster-types.adoc[] to better distribute the data, and the processing of requests, across many servers. Multiple options can be mixed and matched depending on the scalability you need. Best of all, this talk about high-volume applications is not just hypothetical: some of the famous Internet sites that use Solr today are Macy's, EBay, and Zappo's. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/searching-in-solr.adoc b/solr/solr-ref-guide/modules/getting-started/pages/searching-in-solr.adoc index bcb84be..1c13abd 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/searching-in-solr.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/searching-in-solr.adoc @@ -30,15 +30,15 @@ In addition, applications can be configured to allow users to override the defau To process a search query, a request handler calls a _query parser_, which interprets the terms and parameters of a query. Different query parsers support different syntax. -Solr's default query parser is known as the <<standard-query-parser.adoc#,Standard Query Parser>>,or more commonly just the "lucene" query parser. -Solr also includes the <<dismax-query-parser.adoc#,DisMax>>query parser, and the <<edismax-query-parser.adoc#,Extended DisMax>> (eDisMax) query parser. +Solr's default query parser is known as the xref:query-guide:standard-query-parser.adoc[],or more commonly the "lucene" query parser. +Solr also includes the xref:query-guide:dismax-query-parser.adoc[], and the xref:query-guide:edismax-query-parser.adoc[]. -The <<standard-query-parser.adoc#,standard>> query parser's syntax allows for greater precision in searches, but the DisMax query parser is much more tolerant of errors. +The Standard query parser's syntax allows for greater precision in searches, but the DisMax query parser is much more tolerant of errors. The DisMax query parser is designed to provide an experience similar to that of popular search engines such as Google, which rarely display syntax errors to users. The Extended DisMax query parser is an improved version of DisMax that handles the full Lucene query syntax while still tolerating syntax errors. It also includes several additional features. -In addition, there are <<common-query-parameters.adoc#,common query parameters>> that are accepted by all query parsers. +In addition, there are xref:query-guide:common-query-parameters.adoc[] accepted by all query parsers. Input to a query parser can include: @@ -55,7 +55,7 @@ Despite their similar names, query filters are not related to analysis filters. Filter queries perform queries at search time against data already in the index, while analysis filters, such as tokenizers, parse content for indexing, following specified rules. A search query can request that certain terms be highlighted in the search response; that is, the selected terms will be displayed in colored boxes so that they "jump out" on the screen of search results. -<<highlighting.adoc#,_Highlighting_>> can make it easier to find relevant passages in long documents returned in a search. +xref:query-guide:highlighting.adoc[] can make it easier to find relevant passages in long documents returned in a search. Solr supports multi-term highlighting. Solr includes a rich set of search parameters for controlling how terms are highlighted. @@ -63,7 +63,7 @@ Search responses can also be configured to include _snippets_ (document excerpts To help users zero in on the content they're looking for, Solr supports two special ways of grouping search results to aid further exploration: faceting and clustering. -<<faceting.adoc#,*Faceting*>> is the arrangement of search results into categories (which are based on indexed terms). +xref:query-guide:faceting.adoc[] is the arrangement of search results into categories (which are based on indexed terms). Within each category, Solr reports on the number of hits for relevant term, which is called a facet constraint. Faceting makes it easy for users to explore search results on sites such as movie sites and product review sites, where there are many categories and many items within a category. @@ -78,11 +78,11 @@ In the example above, these fields include categories of information that are us The results of clustering often lack the neat hierarchical organization found in faceted search results, but clustering can be useful nonetheless. It can reveal unexpected commonalities among search results, and it can help users rule out content that isn't pertinent to what they're really searching for. -Solr also supports a feature called <<morelikethis.adoc#,MoreLikeThis>>, which enables users to submit new queries that focus on particular terms returned in an earlier query. +Solr also supports a feature called xref:query-guide:morelikethis.adoc[], which enables users to submit new queries that focus on particular terms returned in an earlier query. MoreLikeThis queries can make use of faceting or clustering to provide additional aid to users. -A Solr component called a <<response-writers.adoc#,*response writer*>> manages the final presentation of the query response. -Solr includes a variety of response writers, including an <<response-writers.adoc#standard-xml-response-writer,XML Response Writer>> and a <<response-writers.adoc#json-response-writer,JSON Response Writer>>. +A Solr component called a xref:query-guide:response-writers.adoc[response writer] manages the final presentation of the query response. +Solr includes a variety of response writers, including an xref:query-guide:response-writers.adoc#standard-xml-response-writer[XML Response Writer] and a xref:query-guide:response-writers.adoc#json-response-writer[JSON Response Writer]. The diagram below summarizes some key elements of the search process. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/solr-admin-ui.adoc b/solr/solr-ref-guide/modules/getting-started/pages/solr-admin-ui.adoc index c4669b6..5146fed 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/solr-admin-ui.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/solr-admin-ui.adoc @@ -30,11 +30,11 @@ image::solr-admin-ui/dashboard.png[image,height=400] The left-side of the screen is a menu under the Solr logo that provides the navigation through the screens of the UI. -The first set of links are for system-level information and configuration and provide access to <<configuring-logging.adoc#logging-screen,Logging Screen>>, <<collections-core-admin.adoc#,Collection/Core Administration>>, and <<jvm-settings.adoc#java-properties-screen,Java Properties Screen>>, among other things. +The first set of links are for system-level information and configuration and provide access to xref:deployment-guide:configuring-logging.adoc#logging-screen[Logging Screen], xref:deployment-guide:collections-core-admin.adoc[], and xref:deployment-guide:jvm-settings.adoc#java-properties-screen[Java Properties Screen], among other things. At the end of this information is at least one pulldown listing Solr cores configured for this instance. -On <<cluster-types.adoc#solrcloud-mode,SolrCloud>> nodes, an additional pulldown list shows all collections in this cluster. -Clicking on a collection or core name shows secondary menus of information for the specified collection or core, such as a <<schema-browser-screen.adoc#,Schema Browser>>, <<configuration-files.adoc#files-screen,Files Screen>>, <<plugins-stats-screen.adoc#,Plugins & Statistics>>, and an ability to perform <<query-screen.adoc#,Queries>> on indexed data. +On xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud] nodes, an additional pulldown list shows all collections in this cluster. +Clicking on a collection or core name shows secondary menus of information for the specified collection or core, such as a xref:indexing-guide:schema-browser-screen.adoc[], xref:configuration-guide:configuration-files.adoc#files-screen[Files Screen], xref:deployment-guide:plugins-stats-screen.adoc[], and a xref:query-guide:query-screen.adoc[] on indexed data. The left-side navigation appears on every screen, while the center changes to the detail of the option selected. The Dashboard shows several information items in the center of the screen, including system uptime, the version being run, system-level data, JVM arguments, and the security plugins enabled (if any). @@ -55,8 +55,7 @@ If authentication has been enabled, Solr will present a login screen to unauthen image::solr-admin-ui/login.png[] This login screen currently only works with Basic Authentication. -See the section <<basic-authentication-plugin.adoc#,Basic Authentication Plugin>> for - details on how to configure Solr to use this method of authentication. +See the section xref:deployment-guide:basic-authentication-plugin.adoc[] for details on how to configure Solr to use this method of authentication. Once logged in, the left-hand navigation will show the current user with an option to logout. @@ -80,14 +79,14 @@ These icons include the following links. This server resides at https://issues.apache.org/jira/browse/SOLR. |IRC Channel |Navigates to Solr's http://en.wikipedia.org/wiki/Internet_Relay_Chat[IRC] live-chat room: http://webchat.freenode.net/?channels=#solr. |Community forum |Navigates to the Apache Wiki page which has further information about ways to engage in the Solr User community mailing lists: https://cwiki.apache.org/confluence/display/solr/UsingMailingLists. -|Solr Query Syntax |Navigates to the section <<query-syntax-and-parsers.adoc#,Query Syntax and Parsing>> in this Reference Guide. +|Solr Query Syntax |Navigates to the section xref:query-guide:query-syntax-and-parsers.adoc[] in this Reference Guide. |=== These links cannot be modified without editing the `index.html` in the `server/solr/solr-webapp` directory that contains the Admin UI files. == Security -Users with the `security-edit` permission can manage users, roles, and permissions using the <<security-ui.adoc#,Security>> panel in the Admin UI. +Users with the `security-edit` permission can manage users, roles, and permissions using the xref:deployment-guide:security-ui.adoc[]. Users with the `security-read` permission can view the Security panel but all update actions on the panel are disabled. .Security Screen @@ -95,14 +94,14 @@ image::solr-admin-ui/security.png[image,width=800] == Schema Designer -The <<schema-designer.adoc#,Schema Designer>> screen provides an interactive experience to create a schema using sample data. +The xref:indexing-guide:schema-designer.adoc[] screen provides an interactive experience to create a schema using sample data. image::solr-admin-ui/schema-designer.png[image] .Only Visible When Using SolrCloud [NOTE] ==== -The Schema Designer is only available on Solr instances running <<cluster-types.adoc#solrcloud-mode,SolrCloud>>. +The Schema Designer is only available on Solr instances running xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud]. ==== == Collection-Specific Tools @@ -112,7 +111,7 @@ In the left-hand navigation bar, you will see a pull-down menu titled Collection .Only Visible When Using SolrCloud [NOTE] ==== -The Collection Selector pull-down menu is only available on Solr instances running <<cluster-types.adoc#solrcloud-mode,SolrCloud>>. +The Collection Selector pull-down menu is only available on Solr instances running xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud]. User-managed clusters or single-node installations will not display this menu, instead the Collection specific UI pages described in this section will be available in the <<Core-Specific Tools,Core Selector pull-down menu>>. ==== @@ -145,13 +144,13 @@ Here are sections throughout the Guide describing each screen of the Admin UI: // tag::ui-common-tools[] [cols="1,1",frame=none,grid=none,stripes=none] |=== -| <<configuring-logging.adoc#logging-screen,Logging Screen>>: Recent log messages and configuration of log levels. -| <<security-ui.adoc#,Security>>: Manage users, roles, and permissions. -| <<cloud-screens.adoc#,Cloud Screens>>: Access to SolrCloud node data and status. -| <<schema-designer.adoc#,Schema Designer>>: Interactively create a schema using sample data. -| <<collections-core-admin.adoc#,Collections / Core Admin>>: Collection or Core management tools. -| <<jvm-settings.adoc#java-properties-screen,Java Properties Screen>>: Java information for each core. -| <<thread-dump.adoc#,Thread Dump Screen>>: Detailed thread and state information. +| xref:deployment-guide:configuring-logging.adoc#logging-screen[Logging Screen]: Recent log messages and configuration of log levels. +| xref:deployment-guide:security-ui.adoc[]: Manage users, roles, and permissions. +| xref:deployment-guide:cloud-screens.adoc[]: Access to SolrCloud node data and status. +| xref:indexing-guide:schema-designer.adoc[]: Interactively create a schema using sample data. +| xref:deployment-guide:collections-core-admin.adoc[]: Collection or Core management tools. +| xref:deployment-guide:jvm-settings.adoc#java-properties-screen[Java Properties Screen]: Java information for each core. +| xref:deployment-guide:thread-dump.adoc[]: Detailed thread and state information. | |=== // end::ui-common-tools[] @@ -164,13 +163,13 @@ Here are sections throughout the Guide describing each screen of the Admin UI: // tag::ui-collection-tools[] [cols="1,1",frame=none,grid=none,stripes=none] |=== -| <<analysis-screen.adoc#,Analysis Screen>>: Test and validation tool for field type analyzers. -| <<documents-screen.adoc#,Documents Screen>>: Form-based document updates using the Admin UI. -| <<configuration-files.adoc#files-screen,Files Screen>>: Configuration file browser. -| <<query-screen.adoc#,Query Screen>>: Form-based query builder. -| <<stream-screen.adoc#,Stream Screen>>: Submit streaming expressions and see results and parsing explanations. -| <<sql-screen.adoc#,SQL Screen>>: SQL query runner with tabular results. -| <<schema-browser-screen.adoc#,Schema Browser Screen>>: Field-level schema details. +| xref:indexing-guide:analysis-screen.adoc[]: Test and validation tool for field type analyzers. +| xref:indexing-guide:documents-screen.adoc[]: Form-based document updates using the Admin UI. +| xref:configuration-guide:configuration-files.adoc#files-screen[Files Screen]: Configuration file browser. +| xref:query-guide:query-screen.adoc[]: Form-based query builder. +| xref:query-guide:stream-screen.adoc[]: Submit streaming expressions and see results and parsing explanations. +| xref:query-guide:sql-screen.adoc[]: SQL query runner with tabular results. +| xref:query-guide:schema-browser-screen.adoc[]: Field-level schema details. |=== // end::ui-collection-tools[] **** @@ -182,10 +181,10 @@ Here are sections throughout the Guide describing each screen of the Admin UI: // tag::ui-core-tools[] [cols="1,1",frame=none,grid=none,stripes=none] |=== -| <<ping.adoc#,Ping>>: Ping a named core to determine whether it is active. -| <<plugins-stats-screen.adoc#,Plugins/Stats Screen>>: Statistics for request handlers, search components, plugins, and other installed components. -| <<user-managed-index-replication.adoc#replication-screen,Replication Screen>>: Enable replication for a core and view current replication status. -| <<index-segments-merging.adoc#segments-info-screen,Segments Info Screen>>: Visualization of the underlying Lucene index segments. +| xref:deployment-guide:ping.adoc[]: Ping a named core to determine whether it is active. +| xref:deployment-guide:plugins-stats-screen.adoc[]: Statistics for request handlers, search components, plugins, and other installed components. +| xref:deployment-guide:user-managed-index-replication.adoc#replication-screen[Replication Screen]: Enable replication for a core and view current replication status. +| xref:configuration-guide:index-segments-merging.adoc#segments-info-screen[Segments Info Screen]: Visualization of the underlying Lucene index segments. |=== // end::ui-core-tools[] **** diff --git a/solr/solr-ref-guide/modules/getting-started/pages/solr-glossary.adoc b/solr/solr-ref-guide/modules/getting-started/pages/solr-glossary.adoc index 842bc1e..a1f676b 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/solr-glossary.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/solr-glossary.adoc @@ -31,7 +31,7 @@ Where possible, terms are linked to relevant parts of the Solr Reference Guide f [[SolrGlossary-A]] === A -[[atomicupdates]]<<partial-document-updates.adoc#atomic-updates,Atomic updates>>:: +[[atomicupdates]]xref:indexing-guide:partial-document-updates.adoc#atomic-updates[Atomic updates]:: An approach to updating only one or more fields of a document, instead of reindexing the entire document. @@ -137,7 +137,7 @@ Also known as a Solr server. [[SolrGlossary-O]] === O -[[optimisticconcurrency]]<<partial-document-updates.adoc#optimistic-concurrency,Optimistic concurrency>>:: +[[optimisticconcurrency]]xref:indexing-guide:partial-document-updates.adoc#optimistic-concurrency[Optimistic concurrency]:: Also known as "optimistic locking", this is an approach that allows for updates to documents currently in the index while retaining locking or version control. [[overseer]]Overseer:: @@ -164,17 +164,17 @@ The appropriateness of a document to the search conducted by the user. [[replica]]Replica:: A <<core,Core>> that acts as a physical copy of a <<shard,Shard>> in a <<solrclouddef,SolrCloud>> <<collection,Collection>>. -[[replication]]<<user-managed-index-replication.adoc#,Replication>>:: +[[replication]]xref:deployment-guide:user-managed-index-replication.adoc[Replication]:: A method of copying a leader index from one server to one or more "follower" or "child" servers. -[[requesthandler]]<<requesthandlers-searchcomponents.adoc#,RequestHandler>>:: +[[requesthandler]]xref:configuration-guide:requesthandlers-searchcomponents.adoc[RequestHandler]:: Logic and configuration parameters that tell Solr how to handle incoming "requests", whether the requests are to return search results, to index documents, or to handle other custom situations. [[SolrGlossary-S]] === S -[[searchcomponent]]<<requesthandlers-searchcomponents.adoc#,SearchComponent>>:: +[[searchcomponent]]xref:configuration-guide:requesthandlers-searchcomponents.adoc[SearchComponent]:: Logic and configuration parameters used by request handlers to process query requests. Examples of search components include faceting, highlighting, and "more like this" functionality. @@ -183,28 +183,28 @@ In SolrCloud, a logical partition of a single <<collection,Collection>>. Every shard consists of at least one physical <<replica,Replica>>, but there may be multiple Replicas distributed across multiple <<node,Nodes>> for fault tolerance. See also <<solrclouddef,SolrCloud>>. -[[solrclouddef]]<<cluster-types.adoc#solrcloud-mode,SolrCloud>>:: +[[solrclouddef]]xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud]:: Umbrella term for a suite of functionality in Solr which allows managing a <<cluster,Cluster>> of Solr <<node,Nodes>> for scalability, fault tolerance, and high availability. -[[schema]]<<solr-schema.adoc#,Solr Schema (managed-schema.xml or schema.xml)>>:: +[[schema]]xref:indexing-guide:solr-schema.adoc[Solr Schema (managed-schema.xml or schema.xml)]:: The Solr index Schema defines the fields to be indexed and the type for the field (text, integers, etc.). -By default schema data can be "managed" at run time using the <<schema-api.adoc#,Schema API>> and is typically kept in a file named `managed-schema.xml` which Solr modifies as needed, but a collection may be configured to use a static Schema, which is only loaded on startup from a human edited configuration file - typically named `schema.xml`. -See <<schema-factory.adoc#,Schema Factory Definition in SolrConfig>> for details. +By default schema data can be "managed" at run time using the xref:indexing-guide:schema-api.adoc[] and is typically kept in a file named `managed-schema.xml` which Solr modifies as needed, but a collection may be configured to use a static Schema, which is only loaded on startup from a human edited configuration file - typically named `schema.xml`. +See xref:configuration-guide:schema-factory.adoc[] for details. -[[solrconfig]]<<configuring-solrconfig-xml.adoc#,SolrConfig (solrconfig.xml)>>:: +[[solrconfig]]xref:configuration-guide:configuring-solrconfig-xml.adoc[SolrConfig (solrconfig.xml)]:: The Apache Solr configuration file. Defines indexing options, RequestHandlers, highlighting, spellchecking and various other configurations. The file, `solrconfig.xml`, is located in the Solr home `conf` directory. -[[spellcheck]]<<spell-checking.adoc#,Spell Check>>:: +[[spellcheck]]xref:query-guide:spell-checking.adoc[Spell Check]:: The ability to suggest alternative spellings of search terms to a user, as a check against spelling errors causing few or zero results. [[stopwords]]Stopwords:: Generally, words that have little meaning to a user's search but which may have been entered as part of a <<naturallanguagequery,natural language>> query. Stopwords are generally very small pronouns, conjunctions and prepositions (such as, "the", "with", or "and") -[[suggesterdef]]<<suggester.adoc#,Suggester>>:: +[[suggesterdef]]xref:query-guide:suggester.adoc[Suggester]:: Functionality in Solr that provides the ability to suggest possible query terms to users as they type. [[synonyms]]Synonyms:: diff --git a/solr/solr-ref-guide/modules/getting-started/pages/solr-indexing.adoc b/solr/solr-ref-guide/modules/getting-started/pages/solr-indexing.adoc index 48db792..fbc1315 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/solr-indexing.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/solr-indexing.adoc @@ -24,18 +24,18 @@ A Solr index can accept data from many different sources, including XML files, c Here are the three most common ways of loading data into a Solr index: -* Using the <<indexing-with-tika.adoc#,Solr Cell>> framework built on Apache Tika for ingesting binary files or structured files such as Office, Word, PDF, and other proprietary formats. +* xref:indexing-guide:indexing-with-tika.adoc[], built on Apache Tika for ingesting binary files or structured files such as Office, Word, PDF, and other proprietary formats. * Uploading XML files by sending HTTP requests to the Solr server from any environment where such requests can be generated. -* Writing a custom Java application to ingest data through Solr's Java Client API (which is described in more detail in <<client-apis.adoc#,Client APIs>>). +* Writing a custom Java application to ingest data through Solr's Java Client API (which is described in more detail in xref:deployment-guide:client-apis.adoc[]). Using the Java API may be the best choice if you're working with an application, such as a Content Management System (CMS), that offers a Java API. Regardless of the method used to ingest data, there is a common basic data structure for data being fed into a Solr index: a _document_ containing multiple _fields,_ each with a _name_ and containing _content,_ which may be empty. One of the fields is usually designated as a unique ID field (analogous to a primary key in a database), although the use of a unique ID field is not strictly required by Solr. If the field name is defined in the Schema that is associated with the index, then the analysis steps associated with that field will be applied to its content when the content is tokenized. -Fields that are not explicitly defined in the Schema will either be ignored or mapped to a dynamic field definition (see <<fields-and-schema-design.adoc#,Fields and Schema Design>>), if one matching the field name exists. +Fields that are not explicitly defined in the Schema will either be ignored or mapped to a dynamic field definition (see xref:indexing-guide:fields-and-schema-design.adoc[]), if one matching the field name exists. == The Solr Example Directory diff --git a/solr/solr-ref-guide/modules/getting-started/pages/solr-tutorial.adoc b/solr/solr-ref-guide/modules/getting-started/pages/solr-tutorial.adoc index 3f8c81e..2f9fd41 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/solr-tutorial.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/solr-tutorial.adoc @@ -1,10 +1,5 @@ = Solr Tutorials :experimental: -:page-children: tutorial-techproducts, \ - tutorial-films, \ - tutorial-diy, \ - tutorial-solrcloud, \ - tutorial-aws // 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 @@ -26,11 +21,11 @@ This tutorial covers getting Solr up and running, ingesting a variety of data so and getting a feel for the Solr administrative and search interfaces. The tutorial is organized into three sections that each build on the one before it. -The <<tutorial-techproducts.adoc#,first exercise>> will ask you to start Solr, create a collection, index some basic documents, and then perform some searches. +The xref:tutorial-techproducts.adoc[first exercise] will ask you to start Solr, create a collection, index some basic documents, and then perform some searches. -The <<tutorial-films.adoc#,second exercise>> works with a different set of data, and explores requesting facets with the dataset. +The xref:tutorial-films.adoc[second exercise] works with a different set of data, and explores requesting facets with the dataset. -The <<tutorial-diy.adoc#,third exercise>> encourages you to begin to work with your own data and start a plan for your implementation. +The xref:tutorial-diy.adoc[third exercise] encourages you to begin to work with your own data and start a plan for your implementation. Finally, we'll introduce <<Spatial Queries,spatial search>> and show you how to get your Solr instance back into a clean state. @@ -60,7 +55,7 @@ solr-{solr-docs-version}.0.zip ~$ cd solr-{solr-docs-version}.0/ ---- -If you'd like to know more about Solr's directory layout before moving to the first exercise, see the section <<installing-solr.adoc#directory-layout,Directory Layout>> for details. +If you'd like to know more about Solr's directory layout before moving to the first exercise, see the section xref:deployment-guide:installing-solr.adoc#directory-layout[Directory Layout] for details. == Spatial Queries @@ -68,9 +63,9 @@ If you'd like to know more about Solr's directory layout before moving to the fi Solr has sophisticated geospatial support, including searching within a specified distance range of a given location (or within a bounding box), sorting by distance, or even boosting results by the distance. Some of the example techproducts documents we indexed in Exercise 1 have locations associated with them to illustrate the spatial capabilities. -To reindex this data, see <<tutorial-techproducts.adoc#,Exercise 1>>. +To reindex this data, see xref:tutorial-techproducts.adoc[Exercise 1]. -To learn more about Solr's spatial capabilities, see the section <<spatial-search.adoc#,Spatial Search>>. +To learn more about Solr's spatial capabilities, see the section xref:query-guide:spatial-search.adoc[]. == Wrapping Up diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-aws.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-aws.adoc index fd2489b..178141e 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-aws.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-aws.adoc @@ -21,7 +21,7 @@ This guide is a tutorial on how to set up a multi-node SolrCloud cluster on http This tutorial is not meant for production systems. For one, it uses Solr's embedded ZooKeeper instance, and for production you should have at least 3 ZooKeeper nodes in an ensemble. -There are additional steps you should take for a production installation; refer to <<taking-solr-to-production.adoc#,Taking Solr to Production>> for how to deploy Solr in production. +There are additional steps you should take for a production installation; refer to xref:deployment-guide:taking-solr-to-production.adoc[] for how to deploy Solr in production. In this guide we are going to: @@ -42,7 +42,7 @@ To use this guide, you must have the following: * An https://aws.amazon.com[AWS] account. * Familiarity with setting up a single-node SolrCloud on local machine. -Refer to the <<solr-tutorial.adoc#,Solr Tutorial>> if you have never used Solr before. +Refer to the xref:solr-tutorial.adoc[] if you have never used Solr before. == Launch EC2 instances @@ -200,7 +200,7 @@ You should able to see Solr UI dashboard for both nodes. == Create Collection, Index and Query -You can refer <<solr-tutorial.adoc#,Solr Tutorial>> for an extensive walkthrough on creating collections with multiple shards and replicas, indexing data via different methods and querying documents accordingly. +You can refer to the xref:solr-tutorial.adoc[] for an extensive walkthrough on creating collections with multiple shards and replicas, indexing data via different methods and querying documents accordingly. == Deploying with External ZooKeeper @@ -222,7 +222,7 @@ $ sudo vim /etc/hosts These steps will help you install and configure a single instance of ZooKeeper on AWS. This is not sufficient for a production, use, however, where a ZooKeeper ensemble of at least three nodes is recommended. -See the section <<zookeeper-ensemble.adoc#,ZooKeeper Ensemble>> for information about how to change this single-instance into an ensemble. +See the section xref:deployment-guide:zookeeper-ensemble.adoc[] for information about how to change this single-instance into an ensemble. . Download a stable version of ZooKeeper. In this example we're using ZooKeeper v{ivy-zookeeper-version}. @@ -300,6 +300,6 @@ $ bin/solr start -c -p 8983 -h solr-node-1 -z zookeeper-node:2181 As noted earlier, a single ZooKeeper node is not sufficient for a production installation. See these additional resources for more information about deploying Solr in production, which can be used once you have the EC2 instances up and running: -* <<taking-solr-to-production.adoc#,Taking Solr to Production>> -* <<zookeeper-ensemble.adoc#,ZooKeeper Ensemble>> +* xref:deployment-guide:taking-solr-to-production.adoc[] +* xref:deployment-guide:zookeeper-ensemble.adoc[] ==== diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-diy.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-diy.adoc index 2f961a8..9c9ea11 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-diy.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-diy.adoc @@ -63,10 +63,10 @@ Indexing content such as this demonstrates the need to plan Solr for your data, SolrJ:: SolrJ is a Java-based client for interacting with Solr. -Use <<solrj.adoc#,SolrJ>> for JVM-based languages or other <<client-apis.adoc#,Solr clients>> to programmatically create documents to send to Solr. +Use xref:deployment-guide:solrj.adoc[] for JVM-based languages or other xref:deployment-guide:client-apis.adoc[] to programmatically create documents to send to Solr. Documents Screen:: -Use the Admin UI <<documents-screen.adoc#,Documents tab>> (at http://localhost:8983/solr/#/localDocs/documents) to paste in a document to be indexed, or select `Document Builder` from the `Document Type` dropdown to build a document one field at a time. +Use the Admin UI xref:indexing-guide:documents-screen.adoc[] (at http://localhost:8983/solr/#/localDocs/documents) to paste in a document to be indexed, or select `Document Builder` from the `Document Type` dropdown to build a document one field at a time. Click on the btn:[Submit Document] button below the form to index your document. === Updating Data @@ -107,4 +107,4 @@ You can also modify the above to only delete documents that match a specific que At this point, you're ready to start working on your own. -Jump ahead to the overall <<solr-tutorial.adoc#wrapping-up,wrap up>> when you're ready to stop Solr and remove all the examples you worked with and start fresh. +Jump ahead to the overall xref:solr-tutorial.adoc#wrapping-up[wrap up] when you're ready to stop Solr and remove all the examples you worked with and start fresh. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc index a4fc105..d5a171b 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc @@ -326,7 +326,7 @@ If you wanted to control the number of items in a bucket, you could do something You should only see 4 facets returned. There are a great deal of other parameters available to help you control how Solr constructs the facets and facet lists. -We'll cover some of them in this exercise, but you can also see the section <<faceting.adoc#,Faceting>> for more detail. +We'll cover some of them in this exercise, but you can also see the section xref:query-guide:faceting.adoc[] for more detail. ==== Range Facets diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc index 546a393..83f9c2a 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc @@ -31,15 +31,15 @@ In this section you will learn how to start a SolrCloud cluster using startup sc [TIP] ==== This tutorial assumes that you're already familiar with the basics of using Solr. -If you need a refresher, please see the <<getting-started.adoc#,Getting Started section>> to get a grounding in Solr concepts. +If you need a refresher, please see the xref:solr-tutorial.adoc[] to get a grounding in Solr concepts. If you load documents as part of that exercise, you should start over with a fresh Solr installation for these SolrCloud tutorials. ==== [WARNING] ==== -For security reasons, Solr nodes only accept connections from localhost by default. +For security reasons, Solr nodes only accept connections from `localhost` by default. Administrators setting up SolrCloud deployments with multiple nodes must override this setting. -For more details see <<securing-solr.adoc#network-configuration,here>>. +For more details see the section xref:deployment-guide:securing-solr.adoc#network-configuration[Network Configuration]. ==== == SolrCloud Example @@ -97,15 +97,15 @@ After starting up all nodes in the cluster, the script prompts you for the name The suggested default is "gettingstarted" but you might want to choose a name more appropriate for your specific search application. Next, the script prompts you for the number of shards to distribute the collection across. -<<solrcloud-shards-indexing.adoc#,Sharding>> is covered in more detail later on, so if you're unsure, we suggest using the default of 2 so that you can see how a collection is distributed across multiple nodes in a SolrCloud cluster. +xref:deployment-guide:solrcloud-shards-indexing.adoc[] are covered in more detail later on, so if you're unsure, we suggest using the default of 2 so that you can see how a collection is distributed across multiple nodes in a SolrCloud cluster. Next, the script will prompt you for the number of replicas to create for each shard. -<<solrcloud-shards-indexing.adoc#,Replication>> is covered in more detail later in the guide, so if you're unsure, then use the default of 2 so that you can see how replication is handled in SolrCloud. +Again, this is covered in more detail later in the guide, so if you're unsure, then use the default of 2 so that you can see how replication is handled in SolrCloud. Lastly, the script will prompt you for the name of a configuration directory for your collection. -You can choose *_default*, or *sample_techproducts_configs*. +You can choose `_default`, or `sample_techproducts_configs`. The configuration directories are pulled from `server/solr/configsets/` so you can review them beforehand if you wish. -The *_default* configuration is useful when you're still designing a schema for your documents and need some flexibility as you experiment with Solr, since it has schemaless functionality. +The `_default` configuration is useful when you're still designing a schema for your documents and need some flexibility as you experiment with Solr, since it has schemaless functionality. However, after creating your collection, the schemaless functionality can be disabled in order to lock down the schema (so that documents indexed after doing so will not alter the schema) or to configure the schema by yourself. This can be done as follows (assuming your collection name is `mycollection`): @@ -150,7 +150,7 @@ bin/solr healthcheck -c gettingstarted The healthcheck command gathers basic information about each replica in a collection, such as number of docs, current status (active, down, etc.), and address (where the replica lives in the cluster). -Documents can now be added to SolrCloud using the <<post-tool.adoc#,Post Tool>>. +Documents can now be added to SolrCloud using the xref:indexing-guide:post-tool.adoc[]. To stop Solr in SolrCloud mode, you would use the `bin/solr` script and issue the `stop` command, as in: @@ -214,4 +214,4 @@ bin/solr start -cloud -s example/cloud/node3/solr -p 8987 -z localhost:9983 The previous command will start another Solr node on port 8987 with Solr home set to `example/cloud/node3/solr`. The new node will write its log files to `example/cloud/node3/logs`. -Once you're comfortable with how the SolrCloud example works, we recommend using the process described in <<taking-solr-to-production.adoc#,Taking Solr to Production>> for setting up SolrCloud nodes in production. +Once you're comfortable with how the SolrCloud example works, we recommend using the process described in xref:deployment-guide:taking-solr-to-production.adoc[] for setting up SolrCloud nodes in production. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc index a7f68e5..91bdad1a 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc @@ -104,7 +104,7 @@ Enter `techproducts` at the prompt and hit kbd:[enter]. How many shards would you like to split techproducts into? [2] ---- -This is asking how many <<solr-glossary.adoc#shard,shards>> you want to split your index into across the two nodes. +This is asking how many xref:solr-glossary.adoc#shard[shards] you want to split your index into across the two nodes. Choosing "2" (the default) means we will split the index relatively evenly across both nodes, which is a good way to start. Accept the default by hitting kbd:[enter]. @@ -113,7 +113,7 @@ Accept the default by hitting kbd:[enter]. How many replicas per shard would you like to create? [2] ---- -A replica is a copy of the index that's used for failover (see also the <<solr-glossary.adoc#replica,Solr Glossary definition>>). +A replica is a copy of the index that's used for failover (see also the xref:solr-glossary.adoc#replica[Solr Glossary definition]). Again, the default of "2" is fine to start with here also, so accept the default by hitting kbd:[enter]. [source,subs="verbatim,attributes+"] @@ -191,7 +191,7 @@ We'll use this tool for the indexing examples below. You'll need a command shell to run some of the following examples, rooted in the Solr install directory; the shell from where you launched Solr works just fine. NOTE: Currently the `bin/post` tool does not have a comparable Windows script, but the underlying Java program invoked is available. -We'll show examples below for Windows, but you can also see the <<post-tool.adoc#post-tool-windows-support,Windows section>> of the Post Tool documentation for more details. +We'll show examples below for Windows, but you can also see the section xref:indexing-guide:post-tool.adoc#post-tool-windows-support[Post Tool Windows Support]. The data we will index is in the `example/exampledocs` directory. The documents are in a mix of document formats (JSON, CSV, etc.), and fortunately we can index them all at once: @@ -330,7 +330,7 @@ You should only see the IDs of the matching records returned. All Solr queries look for documents using some field. Often you want to query across multiple fields at the same time, and this is what we've done so far with the "foundation" query. This is possible with the use of copy fields, which are set up already with this set of configurations. -We'll cover copy fields a little bit more in <<tutorial-films.adoc#,Exercise 2>>. +We'll cover copy fields a little bit more in xref:tutorial-films.adoc[Exercise 2]. Sometimes, though, you want to limit your query to a single field. This can make your queries more efficient and the results more relevant for users. @@ -486,7 +486,7 @@ This time you get 13 results. === More Information on Searching We have only scratched the surface of the search options available in Solr. -For more Solr search options, see the <<query-guide.adoc#,Query Guide>>. +For more Solr search options, see xref:query-guide:query-syntax-and-parsers.adoc[]. == Exercise 1 Wrap Up @@ -506,4 +506,4 @@ To stop both of the Solr nodes we started, issue the command: `bin/solr stop -all` -For more information on start/stop and collection options with `bin/solr`, see <<solr-control-script-reference.adoc#,Solr Control Script Reference>>. +For more information on start/stop and collection options with `bin/solr`, see xref:deployment-guide:solr-control-script-reference.adoc[]. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/getting-started.adoc b/solr/solr-ref-guide/src/old-pages/getting-started.adoc similarity index 100% rename from solr/solr-ref-guide/modules/getting-started/pages/getting-started.adoc rename to solr/solr-ref-guide/src/old-pages/getting-started.adoc diff --git a/solr/solr-ref-guide/modules/getting-started/pages/solr-concepts.adoc b/solr/solr-ref-guide/src/old-pages/solr-concepts.adoc similarity index 100% rename from solr/solr-ref-guide/modules/getting-started/pages/solr-concepts.adoc rename to solr/solr-ref-guide/src/old-pages/solr-concepts.adoc
