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

Move HTML Documentation to a separate subproject

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: main (9.0)
    • Fix Version/s: main (9.0)
    • Component/s: general/build
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      Currently Lucene/Solr have some subdirectory "site" containing some fragments for CHANGES.txt formatting and the Markdown to produce the site. The global documentation for both Lucene and Solr should be built with its own subproject :lucene:documentation and :solr:documentation.

      I will provide a PR that does the following:

      • Move Changes.html formatting scripts to gradle subfolder, so they are correctly shared between Lucene and Gradle and allows to split project (currently they live in Lucene only)
      • Move the site contents with correct names a src/assets, src/markdown into the new documentation projects
      • Make packaging of documentation in the projects build.gradle. :lucene:documentation:assemble should assemble the documentation (same for Solr) and export it as configuration
      • The main packaging will use the artifacts provided to put it into TGZ. Also Release manager can build documentation using the above gradlew calls.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                uschindler Uwe Schindler
                Reporter:
                uschindler Uwe Schindler
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2h 10m
                  2h 10m