[SPARK-33479][DOC] Make the API Key of DocSearch configurable #30409
Conversation
| 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 |
There was a problem hiding this 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.
|
cc @beliefer @gatorsmile @maropu @sarutak , since you have reviewed #30292 |
| # documentation of previous releases. | ||
| DOCSEARCH_SCRIPT: | | ||
| docsearch({ | ||
| apiKey: 'b18ca3732c502995563043aa17bc6ecb', |
There was a problem hiding this 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.
|
Test build #131276 has finished for PR 30409 at commit
|
|
Kubernetes integration test starting |
|
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 right? |
|
Kubernetes integration test status success |
@sarutak sure, we should update it after this one is merged. |
|
Test build #131280 has finished for PR 30409 at commit
|
maropu
changed the title
|
Kubernetes integration test starting |
|
Kubernetes integration test status failure |
| 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 |
|
Thanks! Merged to master. |
|
@maropu @sarutak @beliefer Thanks for the review. |
Yes, we should try it. |
5 participants
What changes were proposed in this pull request?
Make the API key of DocSearch configurable and avoid hardcoding in the HTML template
Why are the changes needed?
After #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 #30292 (comment), we should make the API key configurable and set different values for different releases.
Does this PR introduce any user-facing change?
No
How was this patch tested?
Manual test