Skip to content

Generated reference pages for wrapped commands show talosctl in the examples #239

Description

docs/reference/image_cache-create.md documents talm image cache-create, and then gives these examples:

talosctl images cache-create --images=... --image-cache-path=...
talosctl images default | talosctl images cache-create --image-cache-path=... --images=-

That block is upstream talosctl's own example text. It reaches the talm reference because talm wraps the command and the pages are generated from the cobra tree. Someone copying from a talm page runs a binary they may not have installed.

docs/reference/image_integration.md has the same root cause in a different shape: --installer-tag and --talos-tag carry the identical description ("tag of the installer image to use"), so there is no way to tell which one selects what.

Either rewrite the examples for wrapped commands at generation time, or label them on the page as upstream talosctl examples.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation / README / inline help / hint copykind/bugCategorizes issue or PR as related to a bug

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions