Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/docs-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,14 @@ jobs:
set -euo pipefail
# Allow specific historical references (CHANGELOG, ADRs that
# legitimately quote a version, dci-report archive). Reject
# anything else under docs/ that matches the v0.X.Y pattern.
if grep -REn 'v?0\.[0-9]+\.[0-9]+' docs/ \
# anything else under docs/ that matches the vX.Y.Z pattern.
# The literal `v` prefix is required so IP addresses like
# `0.0.0.0` and `127.0.0.1` (legitimate in network docs) are
# not flagged as version drift.
if grep -REn '\bv[0-9]+\.[0-9]+\.[0-9]+\b' docs/ \
--include='*.md' \
--exclude-dir=archive \
| grep -vE '(CHANGELOG|examples/|reference/dci-report|decisions/0007|decisions/0011|decisions/0014|decisions/0017|decisions/0018|decisions/0006|decisions/0010|decisions/0009)'; then
| grep -vE '(CHANGELOG|examples/|reference/dci-report|reference/benchmarks|decisions/0007|decisions/0011|decisions/0014|decisions/0017|decisions/0018|decisions/0006|decisions/0010|decisions/0009|decisions/0012|decisions/0015|decisions/0016)'; then
echo
echo "::error::Hardcoded version string detected in docs/."
echo "Single source of truth is Cargo.toml. Reference Cargo.toml or the CHANGELOG instead."
Expand Down
2 changes: 0 additions & 2 deletions docs/how-to/auto-tune-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,6 @@ tool). The hint is consumed for one request only.

## Iterate

## Iterate

1. Collect traces for a representative period (a few hours to a day).
2. Run the `jq` analysis to find misrouted or slow requests.
3. Adjust one parameter at a time via `grob_configure`.
Expand Down
Loading