You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2022/03/21 18:58:57 UTC
[GitHub] [superset] AAfghahi opened a new pull request #19289: feat: Implements Docusearch into docusaurus docs
AAfghahi opened a new pull request #19289:
URL: https://github.com/apache/superset/pull/19289
<!---
Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/
Example:
fix(dashboard): load charts correctly
-->
### SUMMARY
<!--- Describe the change below, including rationale and design decisions -->
This PR implements docusearch in our current docusaurus documentation. It uses algolia to do so.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
<!--- Skip this if not applicable -->
### TESTING INSTRUCTIONS
<!--- Required! What steps can be taken to manually verify the changes? -->
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] AAfghahi commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
AAfghahi commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r831448152
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review comment:
https://docusaurus.io/docs/search
Says that it is safe to commit this, which feels weird.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] AAfghahi commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
AAfghahi commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r831448456
##########
File path: docs/package.json
##########
@@ -17,6 +17,7 @@
},
"dependencies": {
"@ant-design/icons": "^4.7.0",
+ "@docsearch/react": "^3.0.0",
Review comment:
needed for docuSearch
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] hughhhh commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
hughhhh commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r831479886
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] srinify commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
srinify commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r831454805
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review comment:
It could be similar to how you can publish your google analytics id live and it isn't an issue? Hmm
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] srinify commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
srinify commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r831454805
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review comment:
It could be similar to how you can publish your google analytics id live and it isn't an issue? Hmm
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] AAfghahi merged pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
AAfghahi merged pull request #19289:
URL: https://github.com/apache/superset/pull/19289
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] srinify commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
srinify commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r832219576
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review comment:
cc @villebro
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] villebro commented on a change in pull request #19289: feat: Implements Docusearch into docusaurus docs
Posted by GitBox <gi...@apache.org>.
villebro commented on a change in pull request #19289:
URL: https://github.com/apache/superset/pull/19289#discussion_r834085737
##########
File path: docs/docusaurus.config.js
##########
@@ -159,6 +157,11 @@ const config = {
defaultMode: 'light',
disableSwitch: true,
},
+ algolia: {
+ appId: 'WR5FASX5ED',
+ apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5',
Review 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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org