Skip to content

feat(algolia): add facets based on version for search #1051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
haarchri wants to merge 3 commits into
base: master
Choose a base branch
from
+59 −8
Open

feat(algolia): add facets based on version for search #1051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6afdf98
feat(facets): add filter
haarchri Jan 30, 2026
470ee0c
feat(search): add banners and a note when searching an old version
haarchri Jan 30, 2026
15e6018
feat(docs): add release step for the crawler
haarchri Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/new_release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ labels: release
- [ ] Update `version` in the `_index.md` file of `/content/<new latest>` from `master` to the correct version.
- [ ] Create a [new release/tag](https://github.com/crossplane/docs/releases/new) named `v<EOL version>-archive` to snapshot EOL'd docs.
- [ ] Remove EOL'd docs version from "/content" directory and run `hugo` locally to check for broken links.
- [ ] Trigger [Algolia Crawler](https://crawler.algolia.com/) after publishing to reindex results.
- [ ] Update [Algolia Crawler configuration](https://crawler.algolia.com/) to add new version to `startUrls` (e.g., add `"https://docs.crossplane.io/v<new version>/"`) and remove EOL'd version if applicable.
- [ ] Trigger [Algolia Crawler](https://crawler.algolia.com/) after publishing to reindex results with the new version.
2 changes: 1 addition & 1 deletion themes/geekboot/layouts/_default/baseof.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
{{ end }}

{{ partialCached "footer" . }}
{{ partialCached "scripts" . }}
{{ partial "scripts" . }}
</body>
</html>
62 changes: 56 additions & 6 deletions themes/geekboot/layouts/partials/scripts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,63 @@

<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
<script>
{{ $cur_ver := "" }}
{{/* Only filter if we have a version parameter and it's not "0" (static pages) */}}
{{ if and .Page.Params.version (ne .Page.Params.version "0") }}
{{ if eq .Page.Params.version "master" }}
{{ $cur_ver = "0.0.0-master" }}
{{ else }}
{{ $cur_ver = .Page.Params.version }}
{{ end }}
{{ end }}

docsearch({
container: '#docSearch',
appId: '9UXKYX61NK',
indexName: 'crossplane',
apiKey: 'e07e181044d561f6a4cb7261931d980a',
placeholder: 'Search the docs'
const docSearchInstance = docsearch({
container: '#docSearch',
appId: '9UXKYX61NK',
indexName: 'crossplane',
apiKey: 'e07e181044d561f6a4cb7261931d980a',
placeholder: 'Search the docs',
searchParameters: {
attributesToRetrieve: ['hierarchy.lvl0', 'hierarchy.lvl1', 'hierarchy.lvl2', 'hierarchy.lvl3', 'hierarchy.lvl4', 'hierarchy.lvl5', 'hierarchy.lvl6', 'content', 'type', 'url', 'version']{{ if $cur_ver }},
facetFilters: [['version:{{ $cur_ver }}']]{{ end }}
},
transformItems(items) {
// Add version warning banner and badges after DOM renders
setTimeout(() => {
{{ if and $cur_ver (ne .Page.Params.version "master") (ne .Page.Params.version .Site.Params.latest) }}
// Add warning banner for old version
const dropdown = document.querySelector('.DocSearch-Dropdown-Container');
if (dropdown && !dropdown.hasAttribute('data-version-banner-added')) {
const banner = document.createElement('div');
banner.style.cssText = 'padding: 12px; margin: 0 0 12px 0; background: #fff3cd; color: #856404; border-left: 4px solid #ffc107; font-size: 0.875rem;';
banner.innerHTML = '<strong>Searching in v{{ .Page.Params.version }}</strong><br>You are viewing an older version. Results are filtered to this version only. <a href="/v{{ .Site.Params.latest }}/" style="color: #856404; text-decoration: underline; font-weight: 600;">View v{{ .Site.Params.latest }}</a>';
dropdown.insertBefore(banner, dropdown.firstChild);
dropdown.setAttribute('data-version-banner-added', 'true');
}
{{ end }}

// Add version badges to each hit
items.forEach(item => {
if (item.version && item.version !== '0') {
const hitLink = document.querySelector(`.DocSearch-Hit a[href="${item.url}"]`);
if (hitLink) {
const container = hitLink.querySelector('.DocSearch-Hit-Container');
if (container && !container.hasAttribute('data-version-set')) {
const versionText = item.version === '0.0.0-master' ? 'master' : `v${item.version}`;
const badge = document.createElement('div');
badge.className = 'DocSearch-Hit-version';
badge.textContent = versionText;
badge.style.cssText = 'position: absolute; right: 8px; top: 50%; transform: translateY(-50%); font-size: 0.65rem; font-weight: 600; padding: 2px 6px; background: #5468ff; color: white; border-radius: 3px;';
container.style.position = 'relative';
container.appendChild(badge);
container.setAttribute('data-version-set', 'true');
}
}
}
});
}, 10);
return items;
}
});

</script>