You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2020/11/18 10:45:49 UTC

[GitHub] [spark] gengliangwang opened a new pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

gengliangwang opened a new pull request #30409:
URL: https://github.com/apache/spark/pull/30409


   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
     2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
     4. Be sure to keep the PR description updated to reflect all changes.
     5. Please write your PR title to summarize what this PR proposes.
     6. If possible, provide a concise example to reproduce the issue for a faster review.
     7. If you want to add a new configuration, please read the guideline first for naming configurations in
        'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If you fix some SQL features, you can provide some references of other DBMSes.
     3. If there is design documentation, please add the link.
     4. If there is a discussion in the mailing list, please add the link.
   -->
   
   Make the API key of DocSearch configurable and avoid hardcoding in the HTML template
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   
   After https://github.com/apache/spark/pull/30292, our Spark documentation site supports searching.
   However, the default API key always points to the latest release doc. We have to set different API keys for different releases. Otherwise, the search results are always based on the latest documentation(https://spark.apache.org/docs/latest/) even when visiting the documentation of previous releases.
   
   As per discussion in https://github.com/apache/spark/pull/30292#issuecomment-725613417, we should make the API key configurable and set different values for different releases.
   
   ### Does this PR introduce _any_ user-facing change?
   <!--
   Note that it means *any* user-facing change including all aspects such as the documentation fix.
   If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
   If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
   If no, write 'No'.
   -->
   No
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   -->
   Manual test


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on a change in pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r525989446



##########
File path: docs/_config.yml
##########
@@ -26,3 +26,15 @@ SCALA_VERSION: "2.12.10"
 MESOS_VERSION: 1.0.0
 SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
 SPARK_GITHUB_URL: https://github.com/apache/spark
+# Before a new release, we should apply a new `apiKey` for the new Spark documentation

Review comment:
       An alternative way is, we apply a new API key for the previous release instead. For example, 
   we are going to release 3.1.1 and the current release is 3.1.0. We apply a new API key for https://spark.apache.org/docs/3.1.0 and publish it. After that, we publish 3.1.1 with the default API key which points to the latest doc.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729648019


   Kubernetes integration test status success
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35880/
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729604923


   **[Test build #131276 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131276/testReport)** for PR 30409 at commit [`2da48ff`](https://github.com/apache/spark/commit/2da48ff26b59c01b0f70106f4552370132ec19a6).
    * This patch passes all tests.
    * This patch merges cleanly.
    * This patch adds no public classes.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA removed a comment on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729650268


   **[Test build #131280 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131280/testReport)** for PR 30409 at commit [`b42cf1f`](https://github.com/apache/spark/commit/b42cf1f2fa6386e3978553f80395d7f718965bb2).


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] maropu commented on a change in pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
maropu commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r526025213



##########
File path: docs/_config.yml
##########
@@ -26,3 +26,15 @@ SCALA_VERSION: "2.12.10"
 MESOS_VERSION: 1.0.0
 SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
 SPARK_GITHUB_URL: https://github.com/apache/spark
+# Before a new release, we should apply a new `apiKey` for the new Spark documentation
+# on https://docsearch.algolia.com/. Otherwise, after release, the search results are always based
+# on the latest documentation(https://spark.apache.org/docs/latest/) even when visiting the
+# documentation of previous releases.
+DOCSEARCH_SCRIPT: |
+  docsearch({
+      apiKey: 'b18ca3732c502995563043aa17bc6ecb',

Review comment:
       It makes sense.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] beliefer commented on a change in pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
beliefer commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r526548240



##########
File path: docs/_config.yml
##########
@@ -26,3 +26,15 @@ SCALA_VERSION: "2.12.10"
 MESOS_VERSION: 1.0.0
 SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
 SPARK_GITHUB_URL: https://github.com/apache/spark
+# Before a new release, we should apply a new `apiKey` for the new Spark documentation

Review comment:
       Yeah




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729605084






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729599680


   **[Test build #131276 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131276/testReport)** for PR 30409 at commit [`2da48ff`](https://github.com/apache/spark/commit/2da48ff26b59c01b0f70106f4552370132ec19a6).


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729674295


   Kubernetes integration test starting
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35884/
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on a change in pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r525990772



##########
File path: docs/_config.yml
##########
@@ -26,3 +26,15 @@ SCALA_VERSION: "2.12.10"
 MESOS_VERSION: 1.0.0
 SPARK_ISSUE_TRACKER_URL: https://issues.apache.org/jira/browse/SPARK
 SPARK_GITHUB_URL: https://github.com/apache/spark
+# Before a new release, we should apply a new `apiKey` for the new Spark documentation
+# on https://docsearch.algolia.com/. Otherwise, after release, the search results are always based
+# on the latest documentation(https://spark.apache.org/docs/latest/) even when visiting the
+# documentation of previous releases.
+DOCSEARCH_SCRIPT: |
+  docsearch({
+      apiKey: 'b18ca3732c502995563043aa17bc6ecb',

Review comment:
       Even if we don't set different API keys for different releases, I think it makes sense to avoid hardcoding in the HTML template.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729637470


   Kubernetes integration test starting
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35880/
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-730159116


   @maropu @sarutak @beliefer Thanks for the review.
   As for updating the release process, I am trying to apply a new API key for https://spark.apache.org/docs/3.1.0 . I would like to see if I can get the API key before the doc site actually published.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins removed a comment on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729655023






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins removed a comment on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729648039






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] maropu commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
maropu commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-730082485


   Thanks! Merged to master.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA removed a comment on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729599680


   **[Test build #131276 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131276/testReport)** for PR 30409 at commit [`2da48ff`](https://github.com/apache/spark/commit/2da48ff26b59c01b0f70106f4552370132ec19a6).


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729689054






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins removed a comment on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729689054


   Merged build finished. Test FAILed.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] beliefer commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
beliefer commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-730184544


   > @maropu @sarutak @beliefer Thanks for the review.
   > As for updating the release process, I am trying to apply a new API key for https://spark.apache.org/docs/3.1.0 . I would like to see if I can get the API key before the doc site actually published.
   
   Yes, we should try it.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729648039






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins removed a comment on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729605084






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729654868


   **[Test build #131280 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131280/testReport)** for PR 30409 at commit [`b42cf1f`](https://github.com/apache/spark/commit/b42cf1f2fa6386e3978553f80395d7f718965bb2).
    * This patch passes all tests.
    * This patch merges cleanly.
    * This patch adds no public classes.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on a change in pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r526053669



##########
File path: docs/_layouts/global.html
##########
@@ -187,15 +187,8 @@ <h1 class="title">{{ page.title }}</h1>
             // 2. a JavaScript snippet to be inserted in your website that will bind this Algolia index
             //    to your search input and display its results in a dropdown UI. If you want to find more
             //    details on how works DocSearch, check the docs of DocSearch.
-            docsearch({
-                apiKey: 'b18ca3732c502995563043aa17bc6ecb',
-                indexName: 'apache_spark',
-                inputSelector: '#docsearch-input',
-                enhancedSearchInput: true,
-                debug: false // Set debug to true if you want to inspect the dropdown
-        });
+            {{site.DOCSEARCH_SCRIPT}}
         </script>
-

Review comment:
       Thanks, updated.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729655023






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] maropu closed pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
maropu closed pull request #30409:
URL: https://github.com/apache/spark/pull/30409


   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] sarutak commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
sarutak commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729643306


   Seems fine to me except the minor issue @maropu pointed out.
   
   By the way, though it's not the thing done in this PR, we should also update the [release process](http://spark.apache.org/release-process.html) right?


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729650268


   **[Test build #131280 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/131280/testReport)** for PR 30409 at commit [`b42cf1f`](https://github.com/apache/spark/commit/b42cf1f2fa6386e3978553f80395d7f718965bb2).


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729651391


   > By the way, though it's not the thing done in this PR, we should also update the release process right?
   
   @sarutak sure, we should update it after this one is merged.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] maropu commented on a change in pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
maropu commented on a change in pull request #30409:
URL: https://github.com/apache/spark/pull/30409#discussion_r526025501



##########
File path: docs/_layouts/global.html
##########
@@ -187,15 +187,8 @@ <h1 class="title">{{ page.title }}</h1>
             // 2. a JavaScript snippet to be inserted in your website that will bind this Algolia index
             //    to your search input and display its results in a dropdown UI. If you want to find more
             //    details on how works DocSearch, check the docs of DocSearch.
-            docsearch({
-                apiKey: 'b18ca3732c502995563043aa17bc6ecb',
-                indexName: 'apache_spark',
-                inputSelector: '#docsearch-input',
-                enhancedSearchInput: true,
-                debug: false // Set debug to true if you want to inspect the dropdown
-        });
+            {{site.DOCSEARCH_SCRIPT}}
         </script>
-

Review comment:
       nit: an unnecessary change?




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] gengliangwang commented on pull request #30409: [SPARK-33479][Doc] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
gengliangwang commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729597947


   cc @beliefer @gatorsmile @maropu @sarutak , since you have reviewed https://github.com/apache/spark/pull/30292


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] AmplabJenkins removed a comment on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729689076


   Test FAILed.
   Refer to this link for build results (access rights to CI server needed): 
   https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/35884/
   Test FAILed.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


[GitHub] [spark] SparkQA commented on pull request #30409: [SPARK-33479][DOC] Make the API Key of DocSearch configurable

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #30409:
URL: https://github.com/apache/spark/pull/30409#issuecomment-729689019


   Kubernetes integration test status failure
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35884/
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org