Skip to content

TIKA-4743 improve search and navigation on site#2845

Merged
tballison merged 3 commits into
mainfrom
TIKA-4743-improve-site
May 29, 2026
Merged

TIKA-4743 improve search and navigation on site#2845
tballison merged 3 commits into
mainfrom
TIKA-4743-improve-site

Conversation

@tballison
Copy link
Copy Markdown
Contributor

Thanks for your contribution to Apache Tika! Your help is appreciated!

Before opening the pull request, please verify that

  • there is an open issue on the Tika issue tracker which describes the problem or the improvement. We cannot accept pull requests without an issue because the change wouldn't be listed in the release notes.
  • the issue ID (TIKA-XXXX)
    • is referenced in the title of the pull request
    • and placed in front of your commit messages surrounded by square brackets ([TIKA-XXXX] Issue or pull request title)
  • commits are squashed into a single one (or few commits for larger changes)
  • Tika is successfully built and unit tests pass by running ./mvnw clean test
  • there should be no conflicts when merging the pull request branch into the recent main branch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulled main branch
  • if you add new module that downstream users will depend upon add it to relevant group in tika-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!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.sh to replace UI assets at publish/_ cleanly and to publish search-index.js at 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.

Comment thread docs/supplemental-ui/partials/header-content.hbs Outdated
Comment thread docs/publish-docs.sh
…validate PUBLISH_DIR and refuse symlinked '_'
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Comment thread docs/supplemental-ui/partials/header-content.hbs Outdated
Comment thread docs/publish-docs.sh Outdated
Comment thread docs/publish-docs.sh Outdated
@tballison tballison merged commit 7478ffd into main May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants