VictoriaMetrics/VictoriaMetrics

doc: better way to search for flags

开放

#9,975 创建于 2025年11月7日

 (3 条评论) (1 个反应) (1 位负责人)Go (1,663 个派生)github user discovery
docsenhancementhelp wanted

仓库指标

星标
 (17,118 个星标)
PR 合并指标
 (平均合并 19天 16小时) (30 天内合并 65 个 PR)

描述

Is your feature request related to a problem? Please describe

Currently, the search function does not work on command line flags. For example, when a user want check the flag definition of -relabelConfig, he/she must go to either vmagent or VictoriaMetrics single-node page, and use the search function of the browser (ctrl+f).

This brings extra difficulties for new users who are not familiar with the document structure of VictoriaMetrics, and strictly speaking, it is not the most convenient for experienced users either.

Describe the solution you'd like

I suggest to make command line flags searchable on all pages. A command line flag must be indexed and appear in search result.

Ideally, the command line flag and description should be parsed and formatted correctly in the search result.

Describe alternatives you've considered

There might be other way to improve this, and the common goal should be: user can find everything he need about a flag on any page.

Additional information

Originally from this public question: https://victoriametrics.slack.com/archives/CGZF1H6L9/p1762358837043459

贡献者指南