Skip to content
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.

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

feat: enable docsearch #22

Merged
merged 1 commit into from
May 5, 2021
Merged

feat: enable docsearch #22

merged 1 commit into from
May 5, 2021

Conversation

molant
Copy link
Contributor

@molant molant commented May 3, 2021

Enable docsearch module with provided configuration by algolia.

Currently the search does not seem to work when contextSearch is
enabled. This seems to be a temporary issue per Clement's mail:

As the DocSearch plugin is not active yet, you won't be able to use
the Docusaurus contextualSearch option until next crawl.

While this feature is not necessary (there are no versioned docs),
it seems like the search results page has it enabled by default
always (1) so might as well have it enabled everywhere to make sure it
works.


Ref: facebook/docusaurus#3805
Part of #2

Enable docsearch module with provided configuration by algolia.

Currently the search does not seem to work when `contextSearch` is
enabled. This seems to be a temporary issue per Clement's mail:

> As the DocSearch plugin is not active yet, you won't be able to use
the Docusaurus `contextualSearch` option until next crawl.

While this feature is not necessary (there are no versioned docs),
it seems like the search results page has it enabled by default
always ([1]) so might as well have it enabled everywhere to make sure it
works.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[1]: https://github.com/temporalio/documentation/pull/357/files#r616656533
Ref: facebook/docusaurus#3805
Part of #2
@molant
Copy link
Contributor Author

molant commented May 3, 2021

This is how it looks like when disabling contextualSearch:
Dropdown search results for "context"

The results page is empty:

Search results for "context" returns no results

Before merging this we need to make sure that contextualSearch works so we will have to wait ~24h and deploy the site somewhere. @erickzhao is there a way we can enable "quick test deploys" from GitHub's UI like in the main site repo?

@molant molant mentioned this pull request May 3, 2021
23 tasks
@molant molant temporarily deployed to electronjsor-feat-searc-ro6bay May 5, 2021 15:20 Inactive
@molant molant merged commit 1191485 into main May 5, 2021
@molant molant deleted the feat/search branch May 5, 2021 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant