You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Cassandra Targett (Jira)" <ji...@apache.org> on 2019/10/14 13:55:00 UTC
[jira] [Commented] (SOLR-12786) Upgrade refGuide build to
Asciidoctor 1.5.7 and new link structure
[ https://issues.apache.org/jira/browse/SOLR-12786?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16951014#comment-16951014 ]
Cassandra Targett commented on SOLR-12786:
------------------------------------------
The need for an upgraded version of our tooling intersects with the efforts to discontinue publishing the PDF (SOLR-13782) [1] and the move to build with Gradle (SOLR-13452) [2].
We were held back a bit by not having a version of asciidoctor-ant that included the updated Asciidoctor version we wanted to use, but asciidoctor-ant has now released a version that includes the Asciidoctorj bindings for later Asciidoctor gem versions. We've also as a project decided not to publish the PDF version, so our need for the asciidoctor-ant support really just goes away.
The effort to move our build to Gradle is also easier if we move to an later version - we will be able to download the gems in the build itself, and we might as well get the latest ones.
With the current Ant-based build we can't enforce any version (except in the Jenkins jobs, which are scripted), so there are minimal changes to "upgrade" our versions:
* Change the asciidoctor-ant version in {{./solr/solr-ref-guide/build.xml}}
* Change the version in the README for the HTML build
* Fix the page links that will fail link validation with the updated version
* Update the Jenkins script ({{./dev-tools/scripts/jenkins.build.ref.guide.sh}}) to use the new versions
I'll work on these and try to put up a PR ASAP. I need to figure out where removing the PDF build fits into this - specifically, when to remove it entirely since we haven't told the user community that's what we're doing yet - but I'll start by updating it all and remove it in the other issue I referenced above.
Mailing list threads for reference:
[1] https://lists.apache.org/thread.html/f517b3b74a0a33e5e6fa87e888459fc007decc49d27a4f49822ca2ee@%3Cdev.lucene.apache.org%3E
[2] https://lists.apache.org/thread.html/fdd00fc4970be42aa420d93477ad4c693bc620ce8be1981b1840ca86@%3Cdev.lucene.apache.org%3E
> Upgrade refGuide build to Asciidoctor 1.5.7 and new link structure
> ------------------------------------------------------------------
>
> Key: SOLR-12786
> URL: https://issues.apache.org/jira/browse/SOLR-12786
> Project: Solr
> Issue Type: Improvement
> Components: Build, documentation
> Affects Versions: 8.0
> Reporter: Jan Høydahl
> Priority: Major
> Attachments: SOLR-12786.patch
>
>
> Currently the refguide build requires asciidoctor 1.5.6.2.
> People using {{gem install jekyll-asciidoc}} will end up with version 1.5.7, causing different header ID syntax and the build will break.
> Long term we should move to latest asciidoctor.
> It is already documented in README how to install the older 1.5.6.2 version.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org