tarantool / tarantool/doc

Misleading search index

Open
#3,482 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

internal
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Поиск по доке работает весьма странно.

Например, я пробую искать "vclock": https://www.tarantool.io/en/doc/latest/search/?q=vclock

Выдача выглядит так:

image

Внимание на второй и третий пункты списка. Под box.read_view.list() залезло описание luatest.server.

Server:wait_for_vclock (vclock) Wait until the server’s own vclock reaches at least the given value.

Подобные несоответствия встречаются достаточно часто.

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 by reproducing the vclock search at the linked documentation URL and compare the results for box.read_view.list() and luatest.server. Trace how the search index associates result text with documentation pages; done means these and similar searches no longer show mismatched descriptions.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.