Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-9495

Ref Guide gradle buildSite ignores version parameter

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Information Provided
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: general/build
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      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.)

      Chris M. Hostetter 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).

        Attachments

        Issue Links

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              ctargett Cassandra Targett

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment