ysugimoto/falco

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

Closed

#287 opened on Apr 1, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (47 forks)github user discovery
buggood first issuehelp wanted

Repository metrics

Stars
 (151 stars)
PR merge metrics
 (Avg merge 2d 13h) (3 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Inspect the documentation checker code in cmd/documentation checker/ and the predefined.yml file. Modify the regex to only ignore header variables like `req.http.*` or convert the upstream format to match the predefined format.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Goregex
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45