Open
Conversation
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.
Still largely a WIP, but this PR adds the ability to search across the docs site.
The general workflow:
search-preview.jsonin the root of the site. This contains a JSON document with a title and summary of each page. The title is easy, but the summary we either need to build from the content, or add it as a required field for each doc page we have./search?q=searchTermhttps://search.pulsar-edit.dev(This site needs CORs updates to work in production)search-preview.jsonfile client sideItems to Complete:
How to Test
Testing this locally really sucks because of CORs, where even once we allow CORs requests from
docstosearchit'll still be broken locally. So below I'll add to methods to test locally based on what you want:Static search results: Good for styling the page or generic functionality
On line 53 of
search.jsadd an assignment ofthis.searchResultsto a static array. Such as:Dynamic search results
If you need to actually have dynamic search results, you'll need to spin up a local instance of the search microservice.
So get the search microservice, with the most recent PR (which adds CORs), and change the domain it adds to just be
res.append("Access-Control-Allow-Origin", "*");to letlocalhostwork.Then start it up, and trigger the index of search results with a
POST localhost:8080/reindex/docsThen in this PR change
this.api = http://localhost:8080/search/docsNow you can properly test, bit of a pain, but is how I was able to get it working for making this PR.