mirror of https://github.com/apache/lucene.git
44 lines
2.2 KiB
Plaintext
44 lines
2.2 KiB
Plaintext
= 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
|