Skip to content

Correct what a docs walkthrough measured, and show the fabric's state - #43

Merged
mbakalarski merged 1 commit into
mainfrom
docs-walkthrough-corrections
Aug 7, 2026
Merged

Correct what a docs walkthrough measured, and show the fabric's state#43
mbakalarski merged 1 commit into
mainfrom
docs-walkthrough-corrections

Conversation

@mbakalarski

Copy link
Copy Markdown
Member

Five things found by following docs/ step by step on a live lab rather than
by reading the pages.

  • lab.md printed an image ID nobody can match. docker import builds a
    fresh layer every time, so the same cEOS tarball produces a different ID on
    every machine and on every re-import. It is a placeholder now; the
    repository, tag and size are what a reader should compare.

  • The scenarios overview applied one scenario and removed another. The
    apply block used router, the teardown block used jsonrpc, so following
    both in order deletes resources that were never created:

    Error from server (NotFound): ... bgpglobals.eos.netclab.dev "bgpglobal-on-ceos-jsonrpc" not found
    

    Both blocks now use one scenario, and the page says outright that the
    directory name is the only thing that changes.

  • router.md said "the scenarios below this one", which the navigation
    puts above it. The contrast is about what Router does and does not need
    them named.

  • fabric.md said the whole scenario is one patch. The patch is what this
    repository adds; the scenario is also the render and the push, and the page
    showed neither. It now walks the Fabric and the eight Devices, the
    deviceCount and pyavd's verdict, and status.push on a device that was
    actually configured.

  • fabric.md quoted a device without a command. Every other page gives the
    command whose output it prints. This one showed the leaf's configuration with
    no way to reproduce it; show running-config is where those lines come from,
    scattered through it rather than contiguous.

Everything added here was measured against a running lab today, not carried
over from an earlier session. mkdocs build --strict passes.

Not addressed here, because it is an upstream change: kubectl -n avd get netclab lists nothing, since function-avd's Fabric and Device XRDs carry no
categories. The explicit kinds used above stay correct either way.

🤖 Generated with Claude Code

Five things found by following the pages step by step rather than by
reading them.

The cEOS image ID is per-import: `docker import` builds a fresh layer
every time, so the ID in `lab.md` could never match a reader's. It is a
placeholder now; the repository, tag and size are what should match.

The scenarios overview applied `router` and removed `jsonrpc`, so
following both blocks in order deleted resources that were never
applied. Both use one scenario now, and the page says outright that the
directory name is the only thing that changes.

`router.md` opened with "the scenarios below this one", which the
navigation puts above it. The contrast is about `Router` and does not
need them.

`fabric.md` said the whole scenario is one patch. The patch is what this
repository adds; the scenario is also the render and the push, and the
page never showed either. It now walks the `Fabric` and the eight
`Device`s, the deviceCount and pyavd's verdict, and `status.push` on a
device that was configured -- and gives the command whose output the
running-config excerpt came from, which was quoted without one.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mbakalarski
mbakalarski merged commit b1183fa into main Aug 7, 2026
3 checks passed
@mbakalarski
mbakalarski deleted the docs-walkthrough-corrections branch August 7, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant