4267ca98fa
### 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 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? No ### How was this patch tested? Manual test Closes #30409 from gengliangwang/apiKey. Authored-by: Gengliang Wang <gengliang.wang@databricks.com> Signed-off-by: Takeshi Yamamuro <yamamuro@apache.org>
41 lines
1.2 KiB
YAML
41 lines
1.2 KiB
YAML
highlighter: rouge
|
|
markdown: kramdown
|
|
gems:
|
|
- jekyll-redirect-from
|
|
|
|
# For some reason kramdown seems to behave differently on different
|
|
# OS/packages wrt encoding. So we hard code this config.
|
|
kramdown:
|
|
entity_output: numeric
|
|
|
|
plugins:
|
|
- jekyll-redirect-from
|
|
|
|
include:
|
|
- _static
|
|
- _modules
|
|
- _images
|
|
- _sources
|
|
|
|
# These allow the documentation to be updated with newer releases
|
|
# of Spark, Scala, and Mesos.
|
|
SPARK_VERSION: 3.1.0-SNAPSHOT
|
|
SPARK_VERSION_SHORT: 3.1.0
|
|
SCALA_BINARY_VERSION: "2.12"
|
|
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',
|
|
indexName: 'apache_spark',
|
|
inputSelector: '#docsearch-input',
|
|
enhancedSearchInput: true,
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|