[
https://issues.apache.org/jira/browse/SOLR-14824?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chris M. Hostetter updated SOLR-14824:
--------------------------------------
Attachment: SOLR-14824.patch
Assignee: Chris M. Hostetter
Status: Open (was: Open)
{quote}Next Steps: ...
{quote}
Updated patch includes those outstanding items with a slightly tweaked property
name.
Final syntax with patch applied (as documented in meta-docs/publish.adoc) ...
{noformat}
# build the "DRAFT" guide over and over as much as you want as things change...
./gradlew solr:solr-ref-guide:buildSite
# build the "real" site for final publishing...
./gradlew solr:solr-ref-guide:buildSite -PsolrGuideDraft=false
{noformat}
----
FWIW, based on the conversations in SOLR-14870 I was thinking that instead of a
command line property to control the "DRAFT" status, we should instead really
just have "buildSite" which would always build the "real" (ie: never a DRAFT)
site into build/html-site, while some new "buildLocalGuide" would always build
the "DRAFT" pages (and use relative links to "local" javadocs for validation -
see discussion in SOLR-14870) and the "default" gradle task / workflow should
be to run the "buildLocalGuide" task – leaving "buildSite" as something only
the a committer would run when publishing the site.
BUT ... then i thought about the actaul publishing workflow (as documented in
meta-docs/publish.adoc ) and the fact that we do currently "publish" DRAFT
copies of the site to lucene.apache.org for people to review – up until the
solr release is "final" at which point we publish the "non-draft" version of
the guide
So for now i left in the {{-PsolrGuideDraft=false}} propety ... but it's
something we may want to reconsider down the road?
----
[~ctargett] how does this patch look to you? are there anything you had in mind
for simplification/clean up that i overlooked?
> Simplify set of Ref Guide build parameters
> ------------------------------------------
>
> Key: SOLR-14824
> URL: https://issues.apache.org/jira/browse/SOLR-14824
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: Build, documentation
> Reporter: Cassandra Targett
> Assignee: Chris M. Hostetter
> Priority: Minor
> Attachments: SOLR-14824.patch, SOLR-14824.patch
>
>
> While trying to solve LUCENE-9495, I thought it might be a good idea to try
> to simplify the set of variables and properties used during the Ref Guide
> build.
> There are 3 areas to work on:
> 1. Remove the "barebones-html" build. With Gradle the build is self-contained
> and {{gradlew check}} and {{gradle precommit}} could just build the full docs
> and check them.
> 2. Remove some properties that only existed for a hypothetical need related
> to the now-removed PDF.
> 3. Change remaining properties to be defined directly in build.gradle instead
> of relying on ant properties functionality.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
