05921814e2
### What changes were proposed in this pull request? In the discussion https://github.com/apache/spark/pull/30292#issuecomment-725613417, we planned to apply a new API key for each Spark release. However, it turns that DocSearch supports crawling multiple URLs from one website and filtering by fact key: https://docsearch.algolia.com/docs/config-file/#using-regular-expressions Thanks to the help from shortcuts, our Spark doc supports multiple version now: https://github.com/algolia/docsearch-configs/pull/2868 This PR is to add the fact key in the search script and update the instruction in the comment. ### Why are the changes needed? To support filtering Spark documentation search results by the current document version. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Manual test Closes #30469 from gengliangwang/apiKeyFollowUp. Authored-by: Gengliang Wang <gengliang.wang@databricks.com> Signed-off-by: Takeshi Yamamuro <yamamuro@apache.org>
46 lines
1.5 KiB
YAML
46 lines
1.5 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:
|
|
# 1. update the `version` array for the new Spark documentation
|
|
# on https://github.com/algolia/docsearch-configs/blob/master/configs/apache_spark.json.
|
|
# 2. update the value of `facetFilters.version` in `algoliaOptions` on the new release branch.
|
|
# 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,
|
|
algoliaOptions: {
|
|
'facetFilters': ["version:latest"]
|
|
},
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|