ysugimoto/falco

[BUG] Documentation checker tool misses variables containing `{NAME}`

クローズ

#287 opened on 2024/04/01

 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Go (47 件のフォーク)github user discovery
buggood first issuehelp wanted

Repository metrics

Stars
 (151 個のスター)
PR merge metrics
 (平均マージ 2d 13h) (30d で 3 merged PRs)

説明

Kind of proposals

  • Other

Describe the problem

The documentation checking tool (cmd/documentation-checker/ / make check) is setup to ignore all variables in the Fastly documentation pages that contain {NAME}. This is to ignore the header variables (req.http.*, etc). Which are defined in our predefined.yml file in a different format than the upstream documentation (req.http.%any% vs req.http.{NAME}).

This prevented the tool from noticing variables such as backend.{NAME}.healthy.

Possible solution

This could be fixed by making header regex check more specific to match only the header variables or by removing the regex and instead converting the upstream format to match ours.

コントリビューターガイド