From commits-return-102542-archive-asf-public=cust-asf.ponee.io@lucene.apache.org Mon Jul 30 21:16:37 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 6F283180630 for ; Mon, 30 Jul 2018 21:16:36 +0200 (CEST) Received: (qmail 84346 invoked by uid 500); 30 Jul 2018 19:16:35 -0000 Mailing-List: contact commits-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@lucene.apache.org Delivered-To: mailing list commits@lucene.apache.org Received: (qmail 84337 invoked by uid 99); 30 Jul 2018 19:16:35 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 30 Jul 2018 19:16:35 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4D5FBDFB32; Mon, 30 Jul 2018 19:16:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ctargett@apache.org To: commits@lucene.apache.org Message-Id: <0723e98954e7484882b6822b2cb2c73c@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: lucene-solr:master: SOLR-12164: Ref Guide - improve index.adoc so it's a nicer landing page for the Guide Date: Mon, 30 Jul 2018 19:16:35 +0000 (UTC) Repository: lucene-solr Updated Branches: refs/heads/master 3583bdb32 -> ea221069c 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/ea221069 Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/ea221069 Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/ea221069 Branch: refs/heads/master Commit: ea221069c38bbdc34b058aaae19a6e8f2f46fa0b Parents: 3583bdb Author: Cassandra Targett Authored: Mon Jul 30 13:07:14 2018 -0500 Committer: Cassandra Targett Committed: Mon Jul 30 14:11:55 2018 -0500 ---------------------------------------------------------------------- solr/CHANGES.txt | 10 ++- 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, 144 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ea221069/solr/CHANGES.txt ---------------------------------------------------------------------- diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt index 99c23f1..bf0ab5d 100644 --- a/solr/CHANGES.txt +++ b/solr/CHANGES.txt @@ -59,7 +59,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 @@ -117,7 +117,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) @@ -195,7 +195,7 @@ Optimizations 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) -* 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) Other Changes @@ -223,6 +223,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. @@ -491,7 +493,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/ea221069/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 +--- + + + +{% comment %}NOTE: page_id is also definied in default.html{% endcomment %} +{% assign page_id = page.url | split: '/' | last | remove: '.html' %} +
+

+
+ +
+ + {% if page.summary %} +
{{ page.summary }}
+ {% endif %} + + {% unless page.toc == false %} + {% include toc.html %} + {% endunless %} + +
+ {{content}} +
+ + +{% include footer.html %} http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ea221069/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/ea221069/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/ea221069/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. -*<>*: This section guides you through the installation and setup of Solr. +ifdef::backend-html5[] +++++ +

Download Solr

+++++ +endif::[] +-- -*<>*: 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: -*<>*: 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] +**** -*<>*: 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 *<>* section guides you through the installation and setup of Solr. A detailed tutorial for first-time users shows many of Solr's features. + +*<>*: 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] +**** + +*<>*: 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. + +*<>*: 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] +**** *<>*: This section describes the indexing process and basic index operations, such as commit, optimize, and rollback. *<>*: 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. -*<>*: 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. +*<>*: This section tells you how to access Solr through various client APIs, including JavaScript, JSON, and Ruby. +**** -*<>*: 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] +**** +*<>*: 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. -*<>*: 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 +*<>*: 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. +**** +-- -*<>*: This section describes the newest and most exciting of Solr's new features, SolrCloud, which provides comprehensive distributed capabilities. +[.row] +-- -*<>*: 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] +**** +*<>*: This section describes SolrCloud, which provides comprehensive distributed capabilities. *<>*: 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. +**** -*<>*: 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] +**** +*<>*: When planning how to secure Solr, you should consider which of the available features or approaches are right for you. + +*<>*: 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. +**** +--