diff options
| author | copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> | 2026-05-10 16:16:39 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-10 16:16:39 +0000 |
| commit | 38d085ece37d571a3ab280ce2fcf9b075c00c535 (patch) | |
| tree | a50978dfe1198b6f2c895efd1acf99e84782684b /.github/instructions | |
| parent | d2814d1ea147f89081e15d656bc7172018ee537b (diff) | |
| download | vyos-documentation-38d085ece37d571a3ab280ce2fcf9b075c00c535.tar.gz vyos-documentation-38d085ece37d571a3ab280ce2fcf9b075c00c535.zip | |
docs: suppress literal public IP examples in linter guide
Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/5d679560-8a77-4735-b585-74c09293eea5
Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>
Diffstat (limited to '.github/instructions')
| -rw-r--r-- | .github/instructions/doc-linter.instructions.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/.github/instructions/doc-linter.instructions.md b/.github/instructions/doc-linter.instructions.md index cc56f8fe..358cf9df 100644 --- a/.github/instructions/doc-linter.instructions.md +++ b/.github/instructions/doc-linter.instructions.md @@ -34,12 +34,16 @@ The linter rejects public IP addresses that are not reserved for documentation. **These require `stop/start_vyoslinter` suppression:** +% stop_vyoslinter + | Example | Why suppression is needed | |---------|--------------------------| -| Google Public DNS | Real public IP, not documentation-reserved | +| `8.8.8.8` (Google DNS) | Real public IP, not documentation-reserved | | `64:ff9b::/96` (NAT64) | Well-known prefix, not in doc ranges | | Real provider IPs in examples | Authenticity matters for the example | +% start_vyoslinter + ### Line Length Rules Maximum 80 characters per line. The line-length check is |