You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2020/10/09 20:07:16 UTC
[lucene-solr] branch jira/solr-14900-8x updated: Update Ref Guide
to use latest Jekyll, fix code styling, and update README
This is an automated email from the ASF dual-hosted git repository.
ctargett pushed a commit to branch jira/solr-14900-8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
The following commit(s) were added to refs/heads/jira/solr-14900-8x by this push:
new 22a7bfd Update Ref Guide to use latest Jekyll, fix code styling, and update README
22a7bfd is described below
commit 22a7bfd3834f46fa01f222b5a942cd44102fd336
Author: Cassandra Targett <ca...@lucidworks.com>
AuthorDate: Fri Oct 9 15:06:08 2020 -0500
Update Ref Guide to use latest Jekyll, fix code styling, and update README
---
solr/solr-ref-guide/README.adoc | 11 +++++------
solr/solr-ref-guide/src/_config.yml.template | 4 ++--
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/solr/solr-ref-guide/README.adoc b/solr/solr-ref-guide/README.adoc
index 84b130e..18b2c93 100644
--- a/solr/solr-ref-guide/README.adoc
+++ b/solr/solr-ref-guide/README.adoc
@@ -24,17 +24,17 @@ Raw content is stored in Asciidoc (`.adoc`) formatted files in the `src/` direct
These files are processed with AsciiDoctor.
* HTML is generated using Jekyll with these key dependencies:
-** `Ruby` (v2.3 or higher)
+** `Ruby` (v2.5 or higher)
** The following gems must be installed:
-*** `jekyll`: v3.5, not v4.x.
-Use `gem install jekyll --force --version 3.5.0` to force install of v3.5.0.
+*** `jekyll`: v4.0 or higher; latest version (4.1.1) is fine. The build *will not work* with earlier versions.
+Use `gem install jekyll`.
*** `jekyll-asciidoc`: v2.1 or higher; latest version (3.0.0) is fine.
Use `gem install jekyll-asciidoc` to install.
-*** `slim`: v3.0 or higher; latest version (4.0.1) is fine.
+*** `slim`: v3.0 or higher; latest version (4.1.0) is fine.
Use `gem install slim` to install.
*** `tilt`: v1.0 or higher; latest version (2.0.10) is fine.
Use `gem install tilt` to install.
-*** `concurrent-ruby`: v1.0 or higher; latest version (1.1.5) is fine.
+*** `concurrent-ruby`: v1.0 or higher; latest version (1.1.7) is fine.
Use `gem install concurrent-ruby` to install.
NOTE: The above should install the correct version of the asciidoctor gem implicitly on a new system, but will not upgrade an existing version.
@@ -42,7 +42,6 @@ If you experience problems building that seem unrelated to your changes, check t
This is usually only a problem if you have previously built the ref guide prior to October 2019 or used asciidoctor for some other reason.
`gem info asciidoctor` will show you what version(s) you have installed.
-
== Building the Guide
For details on building the ref guide, see `ant -p`.
diff --git a/solr/solr-ref-guide/src/_config.yml.template b/solr/solr-ref-guide/src/_config.yml.template
index 36c92ed..38069cb 100755
--- a/solr/solr-ref-guide/src/_config.yml.template
+++ b/solr/solr-ref-guide/src/_config.yml.template
@@ -7,7 +7,7 @@
#
# Gems that are included for building the site. jekyll-asciidoc allows Jekyll to use Asciidoctor for variables and settings
-gems: [jekyll-asciidoc]
+plugins: [jekyll-asciidoc]
destination: ../html-site
@@ -94,5 +94,5 @@ asciidoctor:
attribute-missing: "warn"
icons: "font"
source-highlighter: "rouge"
- rouge-theme: "thankful-eyes"
+ rouge-css: "style"
stem: