typelevel / typelevel/typelevel.github.com

Index HOCON config data in search

Open
#589 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
42
Forks
115
Avg merge
5d 5h
Merged PRs (30d)
7

Description

Blog posts and events contain all sorts of nice metadata in their HOCON configs:

https://github.com/typelevel/typelevel.github.com/blob/dee927697b87ff2256ba633079ff166a0689f5ae/src/blog/typelevel-org-built-with-typelevel.md#L1-L5

If we're able to expose this data to protosearch at indexing time then we can enable filtering by author / tag / etc in search.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the HOCON metadata in src/blog/typelevel-org-built-with-typelevel.md, especially the fields shown in the linked lines, and determine where protosearch indexing is configured. The work is done when those metadata fields are exposed during indexing and search can filter by author, tag, and similar values.

Written by the indexing model from the issue text.

Assessment

Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.