[jira] [Updated] (SOLR-10675) differentiate DRAFT builds of the html/pdf ref-guides vs the official releases

["Hoss Man (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-10675?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Hoss Man updated SOLR-10675:
----------------------------
    Attachment: draft-background.png
                SOLR-10675.patch


Here's patch makes a few changes to the way the ref guide is built...

* build.xml now allows differantiation from the *solr* version the guide covers (ex: 6.6) and the *guide* version (ex: 6.6, 6.6.1)
** This will typically be the same - but now if we want to do a "bug fix release" of the guide itself, we can -- and if we do so, the bug fix number for the doc doesn't need to be tied to any particular code bug fix that has/has not yet happened on the same branch_X_Y
* both the PDF & HTML versions will now note their "Guide Version"
** HTML in {{<title>}} and page footer
** PDF in the page footer
* by default, anyone building the PDF or html site wil now get "DRAFT" copies of these files
** the guide version# will default to ending in {{-DRAFT}}
** the the HTML guide will include a DRAFT watermark and special note in the sidebar w/link to official versions
** the PDF filename will include the {{-DRAFT}} suffix
* To build a "release" of the docs, just specify `-Dsolr-guide-version=X.Y` on the command line.
** `ant build-site build-pdf -Dsolr-guide-version=X.Y`
* I also updated the {{meta-docs}} where approrpiate to reflect these changes

(watermark file {{draft-background.png}} attached independently - assume it's in {{solr/solr-ref-guide/src/}}

[~ctargett]: what do you think?



> differentiate DRAFT builds of the html/pdf ref-guides vs the official releases
> ------------------------------------------------------------------------------
>
>                 Key: SOLR-10675
>                 URL: https://issues.apache.org/jira/browse/SOLR-10675
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Hoss Man
>         Attachments: draft-background.png, SOLR-10675.patch
>
>
> We should tweak the build system for the new ref guide so that it's obvious from the artifacts when they are unofficial "DRAFT" copies (default) vs official releases



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org