lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [3/4] lucene-solr:jira/solr-10290: SOLR-10295: Use index.html; fix pub process; add nav for PDFs
Date Fri, 05 May 2017 14:44:04 GMT
SOLR-10295: Use index.html; fix pub process; add nav for PDFs


Branch: refs/heads/jira/solr-10290
Commit: 72e0d34bfdc3dbd8d0af51f1b55904d3b82fb215
Parents: 737464a
Author: Cassandra Targett <>
Authored: Wed May 3 13:35:24 2017 -0500
Committer: Cassandra Targett <>
Committed: Wed May 3 13:35:24 2017 -0500

 solr/solr-ref-guide/build.xml                   |  2 +-
 solr/solr-ref-guide/meta-docs/publish.adoc      | 14 +++++----
 solr/solr-ref-guide/src/_includes/topnav.html   | 11 ++++++-
 .../src/apache-solr-reference-guide.adoc        | 30 --------------------
 4 files changed, 20 insertions(+), 37 deletions(-)
diff --git a/solr/solr-ref-guide/build.xml b/solr/solr-ref-guide/build.xml
index 3e70ab5..98a69bc 100644
--- a/solr/solr-ref-guide/build.xml
+++ b/solr/solr-ref-guide/build.xml
@@ -44,7 +44,7 @@
   <property name="lucene-javadocs" value="${solr-docs-version-path}/"
   <property name="build.content.dir" location="${build.dir}/content" />
-  <property name="main-page" value="apache-solr-reference-guide" />
+  <property name="main-page" value="index" />
   <property name="pdf-filename" value="apache-solr-ref-guide-${solr-docs-version}.pdf"
diff --git a/solr/solr-ref-guide/meta-docs/publish.adoc b/solr/solr-ref-guide/meta-docs/publish.adoc
index 2d2ed18..5a8fccb 100644
--- a/solr/solr-ref-guide/meta-docs/publish.adoc
+++ b/solr/solr-ref-guide/meta-docs/publish.adoc
@@ -139,8 +139,8 @@ If you have the required dependencies on your local machine, you can build
the H
 //TODO update Jenkins link
 If you do not have the required dependencies, and don't choose to install them, you can download
the files from the Jenkins ([Solr
Reference Guide job]).
-// A lot of this was copied from
See that section for explanations for why some steps are required.
 === Publish a New Guide
+// A lot of this was copied from
See that section for explanations for why some steps are required.
 ==== Step 1: Update extpaths.txt in CMS Staging
@@ -181,11 +181,15 @@ You can use the CMS system for this since it is a small change, or you
can edit
 === Update a Published Guide
-If you need to re-publish an existing online copy of the Guide, you will need to checkout
the production website repository and use `svn add` and `svn commit` to overwrite the existing
+If you need to re-publish an existing online copy of the Guide, you will need to checkout
the directory in production website repository and overwrite the existing files:
-. Chekcout the production repo: `svn co`
-. Copy the files from the build location to the correct sub-directory under `solr/guide`.
For example, if we needed to replace the current Guide for Solr 6.5, we'd do `cp -r <checkoutroot>/solr/build/html-site
-. Add the files: `svn add`
+. Build the new HTML files locally (`ant clean build-site`), or download them from Jenkins.
+. Checkout the directory you need to update from the production repo: `svn co<dir>`.
+* This command checks out the Guide version directory into a local subdirectory with the
same name as the version (such as "6_5"). You can provide a better name locally if you prefer
by adding it to the end of the command shown above.
+* Don't shortcut this and download the whole production website. It will take an incredibly
long time and that will feel like _forever_.
+. Copy the files from the build location to the checked out Guide directory. For example,
if we needed to replace the current Guide for Solr 6.5, we'd do `cp -r <checkoutroot>/solr/build/html-site
+. Use `svn status` to see the files modified.
+. If there are any pages added or deleted, use `svn add <file>` or `svn rm <file>`
as needed.
 . Commit the changes: `svn commit -m "Update production 6.5 Ref Guide"`
 // TODO:
diff --git a/solr/solr-ref-guide/src/_includes/topnav.html b/solr/solr-ref-guide/src/_includes/topnav.html
index 82c18a1..bf97b1c 100755
--- a/solr/solr-ref-guide/src/_includes/topnav.html
+++ b/solr/solr-ref-guide/src/_includes/topnav.html
@@ -8,12 +8,21 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
-            <a class="fa fa-home fa-lg navbar-brand" href="apache-solr-reference-guide.html">&nbsp;<span
class="projectTitle"> {{site.topnav_title}} {{ site.solr-attributes.solr-docs-version }}</span></a>
+            <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span
class="projectTitle"> {{site.topnav_title}} {{ site.solr-attributes.solr-docs-version }}</span></a>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
             <ul class="nav navbar-nav navbar-right">
                 <!-- Link to Solr website -->
                 <li><a href="" target="_blank">Solr
+                <!-- Other Guide Formats dropdown -->
+                <li class="dropdown">
+                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Other
Formats<b class="caret"></b></a>
+                    <ul class="dropdown-menu">
+                       <li><a href=""
target="_blank">PDF for Latest Release</a></li>
+                       <li><a href=""
target="_blank">Archived PDFs</a></li>
+                       <li><a href="" target="_blank">Other
Versions Online</a></li>
+                    </ul>
+                </li>
                 <!-- Solr Resources dropdown -->
                 <li class="dropdown">
                     <a href="#" class="dropdown-toggle" data-toggle="dropdown">Solr
Resources<b class="caret"></b></a>
diff --git a/solr/solr-ref-guide/src/apache-solr-reference-guide.adoc b/solr/solr-ref-guide/src/apache-solr-reference-guide.adoc
deleted file mode 100644
index 5491238..0000000
--- a/solr/solr-ref-guide/src/apache-solr-reference-guide.adoc
+++ /dev/null
@@ -1,30 +0,0 @@
-= Apache Solr Reference Guide
-:page-shortname: apache-solr-reference-guide
-:page-permalink: apache-solr-reference-guide.html
-:page-children: about-this-guide, getting-started, upgrading-solr, using-the-solr-administration-user-interface,
documents-fields-and-schema-design, understanding-analyzers-tokenizers-and-filters, indexing-and-basic-data-operations,
searching, the-well-configured-solr-instance, managing-solr, solrcloud, legacy-scaling-and-distribution,
client-apis, major-changes-from-solr-5-to-solr-6, upgrading-a-solr-cluster, further-assistance,
solr-glossary, errata
-This reference guide describes Apache Solr, the open source solution for search. You can
download Apache Solr from the Solr website at
-This Guide contains the following sections:
-**<<getting-started.adoc#getting-started,Getting Started>>**: This section guides
you through the installation and setup of Solr.
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.
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.
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.
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.
-**<<managing-solr.adoc#managing-solr,Managing Solr>>**: This section discusses
important topics for running and monitoring Solr. Other topics include how to back up a Solr
instance, and how to run Solr with Java Management Extensions (JMX).
-**<<solrcloud.adoc#solrcloud,SolrCloud>>**: This section describes the newest
and most exciting of Solr's new features, SolrCloud, which provides comprehensive distributed
-**<<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.

View raw message