Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lucene/solr/solr-ref-guide
History
Cassandra Targett 0b353b6741 SOLR-10842: Move Tutorial to Ref Guide 
Squashed commit of the following:

commit 1cc4de5c4506c757746eac1809f9a7f3d3a55d00
Author: Cassandra Targett <ctargett@apache.org>
Date:   Tue Aug 15 13:23:40 2017 -0500

    SOLR-10842: add Field UI images; rename image paths; minor cleanups

commit 39c7c2f87c54eaaa3341dd119ecd4f0675244a38
Author: Cassandra Targett <ctargett@apache.org>
Date:   Thu Aug 3 15:49:21 2017 -0500

    SOLR-10842: remove running-solr.adoc; move starting solr content to installing-solr; move pages to improve flow; final readthrough

commit 70bea0e73159557f991572ad680a251a0791faec
Author: Cassandra Targett <ctargett@apache.org>
Date:   Wed Aug 2 19:31:57 2017 -0500

    SOLR-10842: rename upgrading-solr.adoc; fix links

commit 0d0cbe7980bf0868ea5d36093aad6101201de82b
Author: Cassandra Targett <ctargett@apache.org>
Date:   Tue Aug 1 09:46:42 2017 -0500

    SOLR-10842: page re-org cleanup; copy edits on tutorial; rename "quick-start" to "tutorial"

commit 4a2635638b214b1480d3b7055afa219ae7bb6a36
Author: Cassandra Targett <ctargett@apache.org>
Date:   Fri Jul 28 13:45:39 2017 -0500

    SOLR-10842: Overhaul of tutorial; update query image

commit 1e1646223b29a0788597d3695b5d0e7ebdd28187
Author: Cassandra Targett <ctargett@apache.org>
Date:   Thu Jul 20 14:13:43 2017 -0500

    little typos

commit e2cb85649dabfd7fd7df6f3d3cce2ca58a4c76a9
Author: Cassandra Targett <ctargett@apache.org>
Date:   Wed Jul 19 09:32:25 2017 -0500

    Change example to use Films

commit 49ad12ca58d5b3bbe60f3cb8f61469bfe321fcc3
Author: Cassandra Targett <ctargett@apache.org>
Date:   Tue Jul 18 09:31:03 2017 -0500

    Further experiments with tabbed layout

commit 21e4dcb38f802f9d2aed795d5c6ba3701b0178ae
Author: Cassandra Targett <ctargett@apache.org>
Date:   Mon Jul 17 16:58:33 2017 -0500

    Fix page links; add experiment with tabs for different data formats

commit c24a9385361d22d7cb51051152b9e1f834c25d45
Author: Cassandra Targett <ctargett@apache.org>
Date:   Thu Jun 29 14:36:01 2017 -0500

    SOLR-10842: minor changes to a few files

commit 819f160423d17dbb647935c5bbfd8a16d4b7b57c
Author: Cassandra Targett <ctargett@apache.org>
Date:   Fri Jun 23 13:49:32 2017 -0500

    SOLR-10842: major page reorg; new content for install and config files

commit 4be7b61ba46f440accdf96757566c3d854e09328
Author: Cassandra Targett <ctargett@apache.org>
Date:   Tue Jun 13 15:34:49 2017 -0500

    SOLR-10842: installation docs

commit c83a9ba91d96d5b75df2191404a3482ca81f8505
Author: Cassandra Targett <ctargett@apache.org>
Date:   Tue Jun 13 13:56:47 2017 -0500

    SOLR-10842: little fixes for quick start

commit 10c1a462338aa16c0435c01eba0506fe09277174
Author: Cassandra Targett <ctargett@apache.org>
Date:   Fri Jun 9 13:47:04 2017 -0500

    SOLR-10842: add quickstart.html from CMS; convert to asciidoc style
 		2017-08-15 14:06:54 -05:00
..
src SOLR-10842: Move Tutorial to Ref Guide 2017-08-15 14:06:54 -05:00
tools squash merge jira/solr-10290 into master 2017-05-10 14:40:25 -07:00
README.adoc SOLR-10725: ASL header in all *.adoc files 2017-05-22 12:50:21 -07:00
build.xml SOLR-10616: parameterize Guide HTML path in sitemap.xml 2017-06-09 17:07:31 -05:00
ivy.xml squash merge jira/solr-10290 into master 2017-05-10 14:40:25 -07:00

README.adoc 

= Solr Ref Guide
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

This is the source for the Solr Reference Guide.

Raw content is stored in Asciidoc (`.adoc`) formated files in the `src/` directory.

These files are processed with AsciiDoctor in 2 different ways:

* Via 'Jekyll' to build an HTML browsable version of the Ref Guide
** Prerequisites: `Ruby` and the following gems must be installed:
*** `jekyll`
*** `jekyll-asciidoc`
*** `pygments.rb`
* Via `asciidoctor-ant` to build the officially released PDF version of the Ref Guide
** Prerequisites: None (except for those required to use the Lucene/Solr build: Java, Ant)

For details on building the ref guide, see `ant -p`.

Key directories to be aware of:

* `src` - where all human edited `*.adoc` files realted to the Guide live, as well as various configuration, theme, and template files.
* `tools` - custom Java code for parsing metadata in our `src/*.adoc` files to produce some `_data/` files for site & pdf navigation purposes.
* `../build/solr-ref-guide/content` - a copy of the `src` dir generated by ant where:
** `*.template` files are processed to replace ant properties with their runtime values
** some `../build/solr-ref-guide/content/_data` files are generated by our java tools based header attributes from each of the `*.adoc` files
* `../build/solr-ref-guide/html-site` - HTML generated version of the ref guide
* `../build/solr-ref-guide/apache-solr-ref-guide-X.Y.pdf` - PDF generated version of the ref guide