Skip to content

[SPARK-57035][DOCS] Always target /docs/latest/ in DocSearch index #56080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gengliangwang wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −9
Open

[SPARK-57035][DOCS] Always target /docs/latest/ in DocSearch index #56080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions dev/create-release/release-tag.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ fi
# Set the release version in docs
sed -i".tmp1" 's/SPARK_VERSION:.*$/SPARK_VERSION: '"$RELEASE_VERSION"'/g' docs/_config.yml
sed -i".tmp2" 's/SPARK_VERSION_SHORT:.*$/SPARK_VERSION_SHORT: '"$RELEASE_VERSION"'/g' docs/_config.yml
sed -i".tmp3" "s/'facetFilters':.*$/'facetFilters': [\"version:$RELEASE_VERSION\"]/g" docs/_config.yml
sed -i".tmp4" 's/__version__: str = .*$/__version__: str = "'"$RELEASE_VERSION"'"/' python/pyspark/version.py

git commit -a -m "Preparing Spark release $RELEASE_TAG"
Expand All @@ -104,8 +103,6 @@ sed -i".tmp6" 's/__version__: str = .*$/__version__: str = "'"$R_NEXT_VERSION.de
sed -i".tmp7" 's/SPARK_VERSION:.*$/SPARK_VERSION: '"$NEXT_VERSION"'/g' docs/_config.yml
# Use R version for short version
sed -i".tmp8" 's/SPARK_VERSION_SHORT:.*$/SPARK_VERSION_SHORT: '"$R_NEXT_VERSION"'/g' docs/_config.yml
# Update the version index of DocSearch as the short version
sed -i".tmp9" "s/'facetFilters':.*$/'facetFilters': [\"version:$R_NEXT_VERSION\"]/g" docs/_config.yml

git commit -a -m "Preparing development version $NEXT_VERSION"

Expand Down
10 changes: 4 additions & 6 deletions docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@ SCALA_BINARY_VERSION: "2.13"
SCALA_VERSION: "2.13.18"
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.
# The DocSearch index is maintained by the Algolia crawler at https://crawler.algolia.com/.
# The crawler indexes only https://spark.apache.org/docs/latest/ and tags every page with
# `version:latest`. All release branches share this single index, so `facetFilters` stays
# pinned to `version:latest` everywhere and no per-release update is required.
DOCSEARCH_SCRIPT: |
docsearch({
apiKey: 'd62f962a82bc9abb53471cb7b89da35e',
Expand Down