Add search functionality and upgrade docusaurus #89
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
john-rock
changed the title
leighstaub
reviewed
Mar 13, 2024
There was a problem hiding this comment.
Looks great, thanks @john-rock ! Excited to have this feature added-- thanks for making it happen.
JKarlavige
approved these changes
Mar 13, 2024
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.
Asana Task
Description
This PR inlcudes the following work required to add a search feature on handbook.getdbt.com
Additional Notes
With the docusaurus v2 upgrade, you'll notice slight UI changes. Creating new and editing existing items should be done the same by modifying the files within the
/docsdirectory.After testing the local search options noted on the docusaurs page here I've determined the plugin in this PR will be the best option for us.
The search plugin only works on a production build of the site. If you need to test locally you'll need to run the command
npm run buildand thennpm run serve.This plugin is a local search so we have much less control than we would using a hosted search index, such as Algolia.
Preview
https://handbook-getdbt-com-git-feature-add-search-dbt-labs.vercel.app
Loom Walkthrough
https://www.loom.com/share/6937f93f6e4f40fe97cd7fa9e9f6fabf