apache / apache/pekko-site

Search doesn't include the documentation produced by the other repositories

Open
#81 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
58
Forks
15
Avg merge
5h 7m
Merged PRs (30d)
5

Description

The search functionality relies on the [search_index.json](https://github.com/apache/incubator-pekko-site/blob/main/content/search/search_index.json) file for indexing the content. Since the site is separate from the paradox docs of each repo, The `search_index.json` of the hompage does have the whole content indexed.

As result, the search only works when you use docs in the right area - the search data is built by all our different doc builds and each repo has its own doc build

https://pekko.apache.org/docs/pekko/current/ has the docs for https://github.com/apache/incubator-pekko
https://pekko.apache.org/docs/pekko-http/current/ has the docs for https://github.com/apache/incubator-pekko-http
So the search in https://pekko.apache.org/docs/pekko/current/ will support searching for actor and stream, etc.

See also: https://github.com/apache/incubator-pekko-site/issues/74

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with content/search/search_index.json and compare how the homepage and the linked repository documentation builds produce their search data. Review issue 74 for related context. Done means the homepage search includes documentation from the other repositories, not only content in the local site area.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.