Skip to content
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.

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

Add zui.brimdata.io as an external site that can be clicked from search results #63

Merged
merged 1 commit into from
May 18, 2023

Conversation

philrz
Copy link
Contributor

@philrz philrz commented May 18, 2023

Per brimdata/zui-docs-site#5, the Algolia DocSearch support folks responded to our request to enable zui.brimdata.io as a second site in our "application". I've since been able to add references to the site as a second entry under startUrls, sitemaps, discoveryPatterns, and pathsToMatch in our crawler config and the index has since rebuilt such that it now has additional entries for zui.brimdata.io. However, as also anticipated at brimdata/zui-docs-site#5, as a next step we need to make the config change in this PR so that search results for that site will have a clickable URL that start with zui.brimdata.io instead of zed.brimdata.io. I've tested this out ok in the staging site at https://spiffy-gnome-8f2834.netlify.app/docs/next (e.g., type "suricata" into the Search tool and you'll get hits you can click successfully).

(Sadly, this does not get everything working to my satisfaction. At the moment the Zui search hits only come up if the user has "Next" selected from the Version drop down. I'm pretty sure I know what's going on and that this is down to "contextual search". However, my digging through their docs has not yet given me solid ideas of what can be done to address it. I'm hoping to just get things partially working with the changes in this PR and then post a question on their user forum and see if anyone can help. I did find this post that looks roughly like what I was trying to achieve and sadly nobody responded to that person, but that was from 2021, so it's probably worth another go. If all of this is a dead end then maybe we need to bite the bullet and redesign everything into a single docs site as I've discussed in the past with @nwt, but it feels like a pretty significant undertaking so I'm inclined to spend a little time trying to extend the life of what we have if it's not too miserable.)

@philrz philrz requested review from mattnibs, nwt and jameskerr May 18, 2023 02:34
@philrz philrz self-assigned this May 18, 2023
@philrz philrz merged commit 511589d into main May 18, 2023
@philrz philrz deleted the search-zui-docs branch May 18, 2023 18:29
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.

2 participants