[SPARK-33479][DOC][FOLLOWUP] DocSearch: Support filtering search results by version #30469
Conversation
| # 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. |
There was a problem hiding this comment.
An alternative way is always to update the current spark doc. For example, if we are going to release 3.1.1 and the current doc version is 3.1.0, we can update the version of http://spark.apache.org/docs/3.1.0 from latest to 3.1.0. For 3.1.1, we can still use the version latest until the next relealse.
|
Hi guys, Feel free to submit a PR whenever you need to add a version (as it only supports |
|
Test build #131548 has finished for PR 30469 at commit
|
|
Kubernetes integration test starting |
|
Kubernetes integration test status success |
maropu
changed the title
|
Btw, any plan to provide this search functionality for the v2.4/v3.0 docs, too? This is very useful for users, I think. |
|
Thanks! Merged to master. |
|
Test build #131584 has finished for PR 30469 at commit
|
|
I'm good with porting back. Its a doc only change in the end |
What changes were proposed in this pull request?
In the discussion #30292 (comment), 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: algolia/docsearch-configs#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