feat: Implements Docusearch into docusaurus docs #19289
Merged
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
superset-github-bot
bot
added
the
Superset-Community-Partners
AAfghahi
commented
Mar 21, 2022
| @@ -159,6 +157,11 @@ const config = { | |||
| defaultMode: 'light', | |||
| disableSwitch: true, | |||
| }, | |||
| algolia: { | |||
| appId: 'WR5FASX5ED', | |||
| apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5', | |||
There was a problem hiding this comment.
https://docusaurus.io/docs/search
Says that it is safe to commit this, which feels weird.
There was a problem hiding this comment.
is there a way for us to embedded these keys via the env? Personally don't think it is a good idea to just have these available for someone to just copy
There was a problem hiding this comment.
I think this is ok, as I believe this is just a reference to the search index (this can probably be extracted fairly easily from the built assets, too)
AAfghahi
commented
Mar 21, 2022
| @@ -17,6 +17,7 @@ | |||
| }, | |||
| "dependencies": { | |||
| "@ant-design/icons": "^4.7.0", | |||
| "@docsearch/react": "^3.0.0", | |||
AAfghahi
removed
the
Superset-Community-Partners
hughhhh
approved these changes
Mar 22, 2022
michael-hoffman-26
pushed a commit
to nielsen-oss/superset
that referenced
this pull request
Mar 23, 2022
9 tasks
villebro
pushed a commit
that referenced
this pull request
Apr 3, 2022
(cherry picked from commit 6083545)
philipher29
pushed a commit
to ValtechMobility/superset
that referenced
this pull request
Jun 9, 2022
mistercrunch
added
🍒 1.5.0
🍒 1.5.1
🍒 1.5.2
🍒 1.5.3
🏷️ bot
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.
SUMMARY
This PR implements docusearch in our current docusaurus documentation. It uses algolia to do so.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION