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

feat: Implements Docusearch into docusaurus docs #19289

Merged
merged 1 commit into from
Mar 22, 2022

Conversation

AAfghahi
Copy link
Member

SUMMARY

This PR implements docusearch in our current docusaurus documentation. It uses algolia to do so.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen Shot 2022-03-21 at 2 49 54 PM
Screen Shot 2022-03-21 at 2 49 45 PM

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@superset-github-bot superset-github-bot bot added the Superset-Community-Partners Preset community partner program participants label Mar 21, 2022
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
algolia: {
appId: 'WR5FASX5ED',
apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docusaurus.io/docs/search

Says that it is safe to commit this, which feels weird.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@@ -17,6 +17,7 @@
},
"dependencies": {
"@ant-design/icons": "^4.7.0",
"@docsearch/react": "^3.0.0",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needed for docuSearch

Copy link
Member

@pkdotson pkdotson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@srinify srinify requested a review from villebro March 22, 2022 13:59
@AAfghahi AAfghahi removed the Superset-Community-Partners Preset community partner program participants label Mar 22, 2022
@hughhhh hughhhh self-requested a review March 22, 2022 18:57
@AAfghahi AAfghahi merged commit 6083545 into apache:master Mar 22, 2022
michael-hoffman-26 pushed a commit to nielsen-oss/superset that referenced this pull request Mar 23, 2022
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 mistercrunch added 🍒 1.5.0 🍒 1.5.1 🍒 1.5.2 🍒 1.5.3 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.0.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels lts-v1 size/S 🍒 1.5.0 🍒 1.5.1 🍒 1.5.2 🍒 1.5.3 🚢 2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants