TIKA-4743 improve search and navigation on site#2845
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Antora docs site UI to change how search is presented/loaded and adjusts the publishing script to match the expected deployed asset layout.
Changes:
- Reworked the header to conditionally render a search input (based on
env.SITE_SEARCH_PROVIDER) and improved burger button ARIA attributes. - Removed the custom Lunr search JS/CSS wiring from the supplemental UI.
- Updated
publish-docs.shto replace UI assets atpublish/_cleanly and to publishsearch-index.jsat the site root.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/supplemental-ui/partials/header-content.hbs | Moves/conditions the search input in the navbar and updates burger button ARIA attributes. |
| docs/supplemental-ui/partials/head-scripts.hbs | Removes custom search stylesheet injection. |
| docs/supplemental-ui/partials/footer-scripts.hbs | Removes custom search script injection. |
| docs/supplemental-ui/js/search.js | Deletes the custom Lunr search implementation. |
| docs/supplemental-ui/css/search.css | Deletes the custom search (and related) styling. |
| docs/publish-docs.sh | Fixes asset copying to avoid nested publish/_/_ and relocates search-index.js publish destination. |
| docs/modules/ROOT/pages/maintainers/release-guides/release-artifacts.adoc | Fixes the website update cross-reference to point at the current page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…validate PUBLISH_DIR and refuse symlinked '_'
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.
Thanks for your contribution to Apache Tika! Your help is appreciated!
Before opening the pull request, please verify that
TIKA-XXXX)[TIKA-XXXX] Issue or pull request title)./mvnw clean testmainbranch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulledmainbranchtika-bom/pom.xml.We will be able to faster integrate your pull request if these conditions are met. If you have any questions how to fix your problem or about using Tika in general, please sign up for the Tika mailing list. Thanks!