[docsy] Enable site search
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with issue #92 and Docsy's search configuration guide, using the recorded GCSE ID 06ecafa260afd40f9. Check whether the site's CSP permits GCSE, then verify that site-wide search works; if it does not, evaluate the documented offline-search alternatives.
Written by the indexing model from the issue text.
Description
Google Custom Search Engine (GCSE) approach:
- Setup GSC: https://search.google.com/search-console?resource_id=sc-domain%3Atheupdateframework.io
- Enable GCSE. For details, see Configure search with a Google Custom Search Engine
- Enable search over entire website
- Note GCSE ID:
06ecafa260afd40f9
- Configure Hugo + Docsy to use new GCSE - #92
- Ensure that the GCSE ID is recognized as a non-profit. (WIP)
In case we can't get GCSE to work with the site's CSP, we should consider alternatives.
- Support offline search. For options, see https://www.docsy.dev/docs/adding-content/search/
- Dominant language
- HTML
- Stars
- 25
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from theupdateframework/theupdateframework.io
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
theupdateframework/theupdateframework.io#184 · 1 comment ·
-
Spec version list on the Specification page is missing v1.0.34, v1.0.35, and v1.0.36May be free again A pull request for this issue was closed without being merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 84/100
theupdateframework/theupdateframework.io#183 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
theupdateframework/theupdateframework.io#182 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Broken-looking link previews on News and Adoptions pages (og:description)May be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
All issues in theupdateframework/theupdateframework.io
Similar issues
-
Complexity: Small non-PR contribution P-Feature: Projects page ready for merge team role: back end/devOps size: 0.25pt
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
[BUG] Case-insensitive search suggestions miss items when the JVM default locale is TurkishPossibly taken @thswlsqls claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
LearningSearch.build_index() does not accept is_continuation, so the search index rebuild failsOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
area:server bug priority:LOW size:S
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
[DOCUMENTATION] Incorrect description of parameter naming for KNN queryPossibly taken @Frank-Gu-81 claimed this today. Open1.3.0 bug documentation P2
Difficulty 1/5 Under an hour Newbie friendliness 88/100
valkey-io/valkey-search#1513 · 1 assignee ·
Maintainers usually reply within 2 days