You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sa...@apache.org on 2017/04/27 18:24:58 UTC
lucene-solr:jira/solr-10290: SOLR-10290: Added pygments.rb to list of
required gems. Fixed build directories.
Repository: lucene-solr
Updated Branches:
refs/heads/jira/solr-10290 a56e8c9b7 -> 49c92bf03
SOLR-10290: Added pygments.rb to list of required gems. Fixed build directories.
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/49c92bf0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/49c92bf0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/49c92bf0
Branch: refs/heads/jira/solr-10290
Commit: 49c92bf03deda0e29c9a0e774ce05cf0bfbe71c5
Parents: a56e8c9
Author: Steve Rowe <sa...@apache.org>
Authored: Thu Apr 27 14:24:38 2017 -0400
Committer: Steve Rowe <sa...@apache.org>
Committed: Thu Apr 27 14:24:38 2017 -0400
----------------------------------------------------------------------
solr/solr-ref-guide/README.adoc | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/49c92bf0/solr/solr-ref-guide/README.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/README.adoc b/solr/solr-ref-guide/README.adoc
index dcca883..fa06fec 100644
--- a/solr/solr-ref-guide/README.adoc
+++ b/solr/solr-ref-guide/README.adoc
@@ -7,8 +7,12 @@ Raw content is stored in Asciidoc (`.adoc`) formated files in the `src/` directo
These files are processed with AsciiDoctor in 2 different ways:
* Via 'Jekyll' to build an HTML browsable version of the Ref Guide
-** NOTE: This currently requires that you have already installed `ruby`, `jekyll`, and the `jekyll-asciidoc` plugin locally
+** 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`.
@@ -16,8 +20,8 @@ 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/content` - a copy of the `src` dir generated by ant where:
+* `../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/content/_data` files are generated by our java tools based header attributes from each of the `*.adoc` files
-* `build/html-site` - HTML generated version of the ref guide
-* `build/apache-solr-ref-guide-X.Y.pdf` - PDF generated version of the ref guide
+** 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