You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2018/07/30 19:21:00 UTC
lucene-solr:branch_7x: SOLR-12164: Ref Guide - improve index.adoc so
it's a nicer landing page for the Guide
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x ea64e53f8 -> fe1647713
SOLR-12164: Ref Guide - improve index.adoc so it's a nicer landing page for the Guide
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/fe164771
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/fe164771
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/fe164771
Branch: refs/heads/branch_7x
Commit: fe164771312bd668a00a77d247b93e6667b8be3d
Parents: ea64e53
Author: Cassandra Targett <ct...@apache.org>
Authored: Mon Jul 30 13:07:14 2018 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Mon Jul 30 14:20:38 2018 -0500
----------------------------------------------------------------------
solr/CHANGES.txt | 11 ++-
solr/solr-ref-guide/src/_layouts/home.html | 31 ++++++++
solr/solr-ref-guide/src/css/customstyles.css | 29 ++++++++
solr/solr-ref-guide/src/css/ref-guide.css | 1 +
solr/solr-ref-guide/src/index.adoc | 91 +++++++++++++++++++----
5 files changed, 145 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/fe164771/solr/CHANGES.txt
----------------------------------------------------------------------
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 7d7ee97..ad9388a 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -31,7 +31,7 @@ Jetty 9.4.11.v20180605
Upgrade Notes
----------------------
-* The data-driven schema no longer returns the *_str field-copy of text fields by default. The *_str field is still
+* The data-driven schema no longer returns the *_str field-copy of text fields by default. The *_str field is still
created and can be used for e.g. sorting, but to retrieve it you now need to explicitly list it in "fl" (SOLR-12350)
* LUCENE-7976: TieredMergePolicy now respects maxSegmentSizeMB by default when executing
@@ -89,7 +89,7 @@ New Features
* SOLR-12567: JSON Facet "functions" now support an extended "type:func" syntax, similar to other types
of facets. This also allows additional local params to be specified for if the aggregation function
can take advantage of them. (hossman)
-
+
* SOLR-12581: the JSON Facet 'relatedness()' aggregate function now supports a 'min_popularity' option
using the extended type:func syntax (hossman)
@@ -163,13 +163,14 @@ Optimizations
* SOLR-11654: Time Routed Alias will now route documents to the ideal shard of a collection, thus avoiding a hop.
Usually documents were already routed well but not always. (Gus Heck, David Smiley)
-* SOLR-12305: When a replica is applying updates, some kind of updates can skip buffering for faster recovery.
+* SOLR-12305: When a replica is applying updates, some kind of updates can skip buffering for faster recovery.
(Cao Manh Dat)
* SOLR-11598: The export handler does not limit users to 4 sort fields and is now unlimited. However the speed at
which we can export is directly proportional to the number of sort fields specified. This change also allows streaming
expressions to group by on more than 4 fields. (Aroop Ganguly, Amrit Sarkar, Varun Thacker)
+
Other Changes
----------------------
@@ -195,6 +196,8 @@ Other Changes
* SOLR-12574: Put under a common "significantTerms" bucket all output by SignificantTerms Query Parser (Alexandre Rafalovitch)
+* SOLR-12164: Improve Ref Guide main landing page. (Cassandra Targett)
+
================== 7.4.0 ==================
Consult the LUCENE_CHANGES.txt file for additional, low level, changes in this release.
@@ -471,7 +474,7 @@ Bug Fixes
* SOLR-12434: bin/solr {config,healthcheck} ignore ZK_HOST in solr.in.{sh,cmd} (Steve Rowe)
-* SOLR-12481: update.autoCreateFields must be set via Config API command 'set-user-property',
+* SOLR-12481: update.autoCreateFields must be set via Config API command 'set-user-property',
but 'bin/solr create' tells users to use the default action 'set-property', which fails
because the property is not editable. (Steve Rowe)
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/fe164771/solr/solr-ref-guide/src/_layouts/home.html
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/_layouts/home.html b/solr/solr-ref-guide/src/_layouts/home.html
new file mode 100644
index 0000000..578fc52
--- /dev/null
+++ b/solr/solr-ref-guide/src/_layouts/home.html
@@ -0,0 +1,31 @@
+---
+layout: default
+---
+
+<!-- This layout is ONLY used for index.adoc, which is the default landing page for the Ref Guide.
+ Its main difference is that it retains the h1 and class for page-title-main, but it does not have any content.
+ This is hacky shortcut to removing the title from the page without having to manipulate CSS.
+ Other major change is it removes all sections that aren't relevant to that page (tags, navlinks & comments). -->
+
+{% comment %}NOTE: page_id is also definied in default.html{% endcomment %}
+{% assign page_id = page.url | split: '/' | last | remove: '.html' %}
+<div class="post-header">
+ <h1 class="post-title-main"></h1>
+</div>
+
+<div class="post-content">
+
+ {% if page.summary %}
+ <div class="summary">{{ page.summary }}</div>
+ {% endif %}
+
+ {% unless page.toc == false %}
+ {% include toc.html %}
+ {% endunless %}
+
+<div class="main-content">
+ {{content}}
+</div>
+
+
+{% include footer.html %}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/fe164771/solr/solr-ref-guide/src/css/customstyles.css
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/css/customstyles.css b/solr/solr-ref-guide/src/css/customstyles.css
index 016b09f..86045a7 100755
--- a/solr/solr-ref-guide/src/css/customstyles.css
+++ b/solr/solr-ref-guide/src/css/customstyles.css
@@ -4,6 +4,35 @@
.gi-4x{font-size: 4em;}
.gi-5x{font-size: 5em;}
+/* Special rules for index.html so rows are all the same height */
+.row.match-my-cols {
+ display: table;
+}
+
+.row.match-my-cols [class*="col-"] {
+ float: none;
+ display: table-cell;
+ vertical-align: top;
+}
+
+/* Changes styling for Bootstrap "jumbotron" component used on index.html
+ Will be inherited by all jumbotron segments used anywhere */
+.jumbotron {
+ background-color: #FAFAFA;
+ border: solid 2px;
+ border-color: #D9411E;
+ padding: 20px;
+ margin-top: 20px;
+}
+
+/* Adds a custom "lead" style for use in index.html jumbotron box */
+.paragraph.lead-homepage > p {
+ font-size: 1.21875em;
+ line-height: 1.3;
+ text-align: center;
+ font-weight: bold;
+}
+
.breadcrumb > .active {color: #777 !important;}
.post-content img {
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/fe164771/solr/solr-ref-guide/src/css/ref-guide.css
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/css/ref-guide.css b/solr/solr-ref-guide/src/css/ref-guide.css
index 1092830..907e2e4 100644
--- a/solr/solr-ref-guide/src/css/ref-guide.css
+++ b/solr/solr-ref-guide/src/css/ref-guide.css
@@ -1556,6 +1556,7 @@ table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p
margin-top: 0;
color: #7a2518;
text-align: center;
+ padding-bottom: 10px;
}
.exampleblock > .content > :last-child>:last-child,
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/fe164771/solr/solr-ref-guide/src/index.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/index.adoc b/solr/solr-ref-guide/src/index.adoc
index ed6d4fd..794e13d 100644
--- a/solr/solr-ref-guide/src/index.adoc
+++ b/solr/solr-ref-guide/src/index.adoc
@@ -1,5 +1,8 @@
= Apache Solr Reference Guide
:page-children: about-this-guide, getting-started, deployment-and-operations, using-the-solr-administration-user-interface, documents-fields-and-schema-design, understanding-analyzers-tokenizers-and-filters, indexing-and-basic-data-operations, searching, solrcloud, legacy-scaling-and-distribution, the-well-configured-solr-instance, monitoring-solr, securing-solr, client-apis, further-assistance, solr-glossary, errata, how-to-contribute
+:page-notitle:
+:page-toc: false
+:page-layout: home
// 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
@@ -17,35 +20,95 @@
// specific language governing permissions and limitations
// under the License.
-[.lead]
-This reference guide describes Apache Solr, the open source solution for search.
+[.jumbotron]
+--
+[.lead-homepage]
+Welcome to Apache Solr(TM), the open source solution for search and analytics.
-Solr builds on Lucene, an open source Java library that provides indexing and search technology, as well as spellchecking, hit highlighting and advanced analysis/tokenization capabilities. Both Solr and Lucene are managed by the Apache Software Foundation (http://www.apache.org/[www.apache.org)]. You can download Apache Solr from the Solr website at http://lucene.apache.org/solr/.
+Solr is the fast open source search platform built on Apache Lucene(TM) that provides scalable indexing and search, as well as faceting, hit highlighting and advanced analysis/tokenization capabilities. Solr and Lucene are managed by the http://www.apache.org/[Apache Software Foundation].
-This Guide contains the following main sections:
+This Reference Guide is the official Solr documentation, written and published by Lucene/Solr committers.
-*<<getting-started.adoc#getting-started,Getting Started>>*: This section guides you through the installation and setup of Solr.
+ifdef::backend-html5[]
+++++
+<p><a class="btn btn-primary btn-lg noCrossRef" href="https://lucene.apache.org/solr/mirrors-solr-latest-redir.html" role="button">Download Solr</a></p>
+++++
+endif::[]
+--
-*<<using-the-solr-administration-user-interface.adoc#using-the-solr-administration-user-interface,Using the Solr Administration User Interface>>*: This section introduces the Solr Web-based user interface. From your browser you can view configuration files, submit queries, view logfile settings and Java environment settings, and monitor and control distributed configurations.
+The Guide includes the following sections:
-*<<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>>*: This section describes how Solr organizes its data for indexing. It explains how a Solr schema defines the fields and field types which Solr uses to organize data within the document files it indexes.
+[.row.match-my-cols]
+--
+.Getting Started with Solr
+[sidebar.col-sm-6.col-md-4]
+****
-*<<understanding-analyzers-tokenizers-and-filters.adoc#understanding-analyzers-tokenizers-and-filters,Understanding Analyzers, Tokenizers, and Filters>>*: This section explains how Solr prepares text for indexing and searching. Analyzers parse text and produce a stream of tokens, lexical units used for indexing and searching. Tokenizers break field data down into tokens. Filters perform other transformational or selective work on token streams.
+The *<<getting-started.adoc#getting-started,Getting Started>>* section guides you through the installation and setup of Solr. A detailed tutorial for first-time users shows many of Solr's features.
+
+*<<using-the-solr-administration-user-interface.adoc#using-the-solr-administration-user-interface,Using the Solr Administration User Interface>>*: This section introduces the Web-based interface for administering Solr. From your browser you can view configuration files, submit queries, view logfile settings and Java environment settings, and monitor and control distributed configurations.
+****
+
+.Deploying Solr
+[sidebar.col-sm-6.col-md-4]
+****
+
+*<<deployment-and-operations.adoc#deployment-and-operations,Deployment and Operations>>*: Once you have Solr configured, you want to deploy it to production and keep it up to date. This section includes information about how to take Solr to production, run it in HDFS or AWS, and information about upgrades and managing Solr from the command line.
+
+*<<monitoring-solr.adoc#monitoring-solr,Monitoring Solr>>*: Solr includes options for keeping an eye on the performance of your Solr cluster with the web-based administration console, through the command line interface, or using REST APIs.
+****
+--
+[.row]
+--
+
+'''
+
+--
+
+[.row.match-my-cols]
+--
+.Indexing & Searching Documents
+[sidebar.col-sm-6.col-md-4]
+****
*<<indexing-and-basic-data-operations.adoc#indexing-and-basic-data-operations,Indexing and Basic Data Operations>>*: This section describes the indexing process and basic index operations, such as commit, optimize, and rollback.
*<<searching.adoc#searching,Searching>>*: This section presents an overview of the search process in Solr. It describes the main components used in searches, including request handlers, query parsers, and response writers. It lists the query parameters that can be passed to Solr, and it describes features such as boosting and faceting, which can be used to fine-tune search results.
-*<<the-well-configured-solr-instance.adoc#the-well-configured-solr-instance,The Well-Configured Solr Instance>>*: This section discusses performance tuning for Solr. It begins with an overview of the `solrconfig.xml` file, then tells you how to configure cores with `solr.xml`, how to configure the Lucene index writer, and more.
+*<<client-apis.adoc#client-apis,Client APIs>>*: This section tells you how to access Solr through various client APIs, including JavaScript, JSON, and Ruby.
+****
-*<<monitoring-solr.adoc#monitoring-solr,Monitoring Solr>>*: Administration and monitoring can be performed using the web-based administration console, through the command line interface, or using REST APIs.
+.Designing Fields
+[sidebar.col-sm-6.col-md-4]
+****
+*<<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>>*: This section describes how Solr organizes data in the index. It explains how a Solr schema defines the fields and field types which Solr uses to organize data within the document files it indexes.
-*<<deployment-and-operations.adoc#deployment-and-operations,Deployment and Operations>>*: An important aspect of Solr is that all operations and deployment can be done online, with minimal or no impact to running applications. This includes minor upgrades and provisioning and removing nodes, backing up and restoring indexes and editing configurations
+*<<understanding-analyzers-tokenizers-and-filters.adoc#understanding-analyzers-tokenizers-and-filters,Understanding Analyzers, Tokenizers, and Filters>>*: This section explains how Solr prepares text for indexing and searching. Analyzers parse text and produce a stream of tokens, lexical units used for indexing and searching. Tokenizers break field data down into tokens. Filters perform other transformational or selective work on token streams.
+****
+--
-*<<solrcloud.adoc#solrcloud,SolrCloud>>*: This section describes the newest and most exciting of Solr's new features, SolrCloud, which provides comprehensive distributed capabilities.
+[.row]
+--
-*<<securing-solr.adoc#securing-solr,Securing Solr>>*: When planning how to secure Solr, you should consider which of the available features or approaches are right for you.
+'''
+
+--
+
+[.row.match-my-cols]
+--
+.Scaling Solr
+[sidebar.col-sm-6.col-md-4]
+****
+*<<solrcloud.adoc#solrcloud,SolrCloud>>*: This section describes SolrCloud, which provides comprehensive distributed capabilities.
*<<legacy-scaling-and-distribution.adoc#legacy-scaling-and-distribution,Legacy Scaling and Distribution>>*: This section tells you how to grow a Solr distribution by dividing a large index into sections called shards, which are then distributed across multiple servers, or by replicating a single index across multiple services.
+****
-*<<client-apis.adoc#client-apis,Client APIs>>*: This section tells you how to access Solr through various client APIs, including JavaScript, JSON, and Ruby.
+.Advanced Configuration
+[sidebar.col-sm-6.col-md-4]
+****
+*<<securing-solr.adoc#securing-solr,Securing Solr>>*: When planning how to secure Solr, you should consider which of the available features or approaches are right for you.
+
+*<<the-well-configured-solr-instance.adoc#the-well-configured-solr-instance,The Well-Configured Solr Instance>>*: This section discusses performance tuning for Solr. It begins with an overview of the `solrconfig.xml` file, then tells you how to configure cores with `solr.xml`, how to configure the Lucene index writer, and more.
+****
+--