Remove docs/ from the Solr binary distribution#4641
Open
dsmiley wants to merge 2 commits into
Open
Conversation
…E.txt The docs/ folder bundled in solr/packaging's distributions contained only a stub index.html redirecting to the real online documentation, plus an HTML rendering of CHANGELOG.md that already ships verbatim at the top level of the distribution. None of this was real documentation, so it is dropped from packaging and its two links (online docs, online Changes.html) are folded directly into README.txt's existing "Files included" section instead. The online docs link is version-pinned per release using the existing solrDocUrl property, substituted via a Gradle ReplaceTokens filter on README.txt, with a SNAPSHOT/custom-build fallback message for non-release builds. solr/packaging/build.gradle no longer depends on :solr:documentation's minimalSite configuration, and the corresponding docs entries were removed from smokeTestRelease.py's expected top-level directory lists for both the slim and full distributions. This also exposed that ./gradlew assemble was unconditionally rebuilding all of Solr's documentation (full javadocs, markdown-to-html, and the now-removed minimal stub site) via :solr:documentation's assemble task, even though that output is only needed by the release process (which invokes gradle documentation directly to publish to svn.apache.org/repos/infra/sites/solr/docs) or by the ref guide build (which resolves :solr:documentation's site/javadocs configurations explicitly). assemble no longer depends on the documentation task, and the root documentation task (used by the release wizard) now depends directly on :solr:documentation:documentation instead of routing through :solr:documentation:assemble. With packaging's last consumer gone, the entire minimalSite mechanism is deleted outright: the documentationMinimal, copyMiniDocumentationAssets, and copyChangesToHtmlForMiniSite tasks, the minimalSite configuration and artifact, the docrootMinimal property, the createMiniDocumentationIndex task, and its online-link.template.md template. Verified by building both distributions locally with SNAPSHOT and simulated release versions to confirm no docs/ directory ships and README.txt renders the correct URL or fallback text, by dry-running gw assemble/gw documentation/gw :solr:documentation:check to confirm the task graphs behave as expected, and by running :solr:documentation:documentation directly to confirm the full site still builds.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove docs/ from the Solr binary distribution; fold links into README.txt
The docs/ folder bundled in solr/packaging's distributions contained only a stub index.html redirecting to the real online documentation, plus an HTML rendering of CHANGELOG.md that already ships verbatim at the top level of the distribution. None of this was real documentation, so it is dropped from packaging and its two links (online docs, online Changes.html) are folded directly into README.txt's existing "Files included" section instead. The online docs link is version-pinned per release using the existing solrDocUrl property, substituted via a Gradle ReplaceTokens filter on README.txt, with a SNAPSHOT/custom-build fallback message for non-release builds. solr/packaging/build.gradle no longer depends on :solr:documentation's minimalSite configuration, and the corresponding docs entries were removed from smokeTestRelease.py's expected top-level directory lists for both the slim and full distributions.
This also exposed that ./gradlew assemble was unconditionally rebuilding all of Solr's documentation (full javadocs, markdown-to-html, and the now-removed minimal stub site) via :solr:documentation's assemble task, even though that output is only needed by the release process (which invokes gradle documentation directly to publish to svn.apache.org/repos/infra/sites/solr/docs) or by the ref guide build (which resolves :solr:documentation's site/javadocs configurations explicitly). assemble no longer depends on the documentation task, and the root documentation task (used by the release wizard) now depends directly on :solr:documentation:documentation instead of routing through :solr:documentation:assemble. With packaging's last consumer gone, the entire minimalSite mechanism is deleted outright: the documentationMinimal, copyMiniDocumentationAssets, and copyChangesToHtmlForMiniSite tasks, the minimalSite configuration and artifact, the docrootMinimal property, the createMiniDocumentationIndex task, and its online-link.template.md template.
Verified by building both distributions locally with SNAPSHOT and simulated release versions to confirm no docs/ directory ships and README.txt renders the correct URL or fallback text, by dry-running gw assemble/gw documentation/gw :solr:documentation:check to confirm the task graphs behave as expected, and by running :solr:documentation:documentation directly to confirm the full site still builds.