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 2020/09/01 19:37:00 UTC

[jira] [Created] (LUCENE-9495) Ref Guide gradle buildSite ignores version parameter

Cassandra Targett created LUCENE-9495:
-----------------------------------------

             Summary: Ref Guide gradle buildSite ignores version parameter
                 Key: LUCENE-9495
                 URL: https://issues.apache.org/jira/browse/LUCENE-9495
             Project: Lucene - Core
          Issue Type: Bug
          Components: general/build
            Reporter: Cassandra Targett


All Ref Guide builds by default are built as drafts. A DRAFT watermark is inserted on to every page, a special header is added to the side navigation, and the footer version includes the word "-DRAFT".

To accomplish this, the guide has long used a parameter {{solr-guide-version}} to indicate when a build for the Ref Guide _should not_ be considered a draft. With the Gradle build, this no longer works. (I thought I'd tested this, but either I missed it or it broke at some point in between.)

[~hossman] set this up several years ago, so cc'ing him here so he can take a look and see why the logic would stop working now.

Links:

Ref Guide {{build.gradle}} that determines Guide version: https://github.com/apache/lucene-solr/blob/master/solr/solr-ref-guide/build.gradle#L128

Ant {{build.xml}} the above was adapted from: https://github.com/apache/lucene-solr/blob/branch_8x/solr/solr-ref-guide/build.xml#L70 

Beyond getting this to work, I think it's worth a discussion (separate Jira?) about whether we can simplify it. Maybe just a parameter {{ref-guide-draft=false}} would be sufficient? We might also reconsider the variations of versions in the Ref Guide params and whether we really need them ({{solr-guide-version}}, {{solr-docs-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