Merge pull request 'docs: replace the old "Large1" port-label examples' (#50) from docs/large1-leftovers into main
Lint / JS (eslint) (push) Successful in 9s
Lint / Python (flake8) (push) Successful in 54s
Lint / Notify on failure (push) Skipped
Security / Python Security (bandit) (push) Successful in 1m3s
Test / Python Tests (pytest) (push) Successful in 1m43s
Lint / Deploy (push) Successful in 5s

This commit was merged in pull request #50.
This commit is contained in:
2026-11-18 16:18:30 -05:00
3 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -227,7 +227,7 @@ servers along the bottom. Power gear (PDU, UPS, power strip) sits in a rail on t
named "Patch panel port 1" (the device beyond the panel is unknown); a stub that already has a name
keeps it and adds "via Patch panel port 2". The cable details show where the cutsheet cable goes.
- **Port names**: a ⚠ marks a port named after one device with a different one plugged in (a port
called "Large1 Management" with the AP on it). Generic names ("Port 4", "SFP+ 2", "Uplink") and
called "compute-storage-02 Management" with the AP on it). Generic names ("Port 4", "SFP+ 2", "Uplink") and
"Downlink to X" with X on the other end never flag.
- **Alerts**: a device with active alerts (not suppressed) gets a ring and a count in its worst
severity colour, and the NIC it is about is marked.
+1 -1
View File
@@ -62,7 +62,7 @@ def link(text: str, url: str) -> str:
def port_text(switch: str, port_name: str, port: dict) -> str:
"""'8SFP-AGG port 7 "Large1": up at 10 Gbps, DAC'"""
"""'8SFP-AGG port 7 "compute-storage-02": up at 10 Gbps, DAC'"""
idx = port.get('port_idx')
text = f'{switch} port {idx}' if idx is not None else f'{switch} {port_name}'
if port_name and idx is not None and port_name != f'Port {idx}':
+2 -2
View File
@@ -25,7 +25,7 @@ _TOKEN_RE = re.compile(r'[a-z0-9]+')
def _norm(name: str) -> str:
"""A name with case, spaces, dashes and underscores ignored: "Large1" == "large-1"."""
"""A name with case, spaces, dashes and underscores ignored: "Storage-01" == "storage_01"."""
return ''.join(_TOKEN_RE.findall((name or '').lower()))
@@ -114,7 +114,7 @@ def name_mismatch(port_name: str, neighbour: str, own: str, known: Dict[str, str
"""A port named after a different device than the one plugged into it.
known: {normalised name: display name} of every device. Runs of up to four words of
the port name are compared with them, so "Large1 Management" names large1 and
the port name are compared with them, so "Storage-01 Management" names storage-01 and
"Downlink to 24RJ45-POE" names 24RJ45-POE. Ports named only "Port 4" never match.
"""
if not port_name or _is_generic_port_name(port_name):