Generated reference pages for wrapped commands show talosctl in the examples
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 67/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- go
- Área
- documentation
Línea de trabajo
Read the Cobra-based reference-page generation path and compare docs/reference/image_cache-create.md with the upstream talosctl examples; also inspect docs/reference/image_integration.md for the duplicate flag descriptions. Decide whether to rewrite wrapped-command examples during generation or label them as upstream examples, and clarify what --installer-tag and --talos-tag select. Done when the generated pages distinguish talm commands from upstream examples and the two flag descriptions are distinguishable.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Go
- Estrellas
- 493
- Forks
- 23
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 4
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de cozystack/talm
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
TestCommittedTextFilesIgnoresUntrackedArtefacts commits into the real repo when GIT_DIR is setAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 Menos de una hora Aptitud para principiantes 70/100
-
area/apply area/commands area/upgrade kind/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Todos los issues de cozystack/talm
Issues similares
-
Mend: dependency security vulnerability
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
kube-tarian/sigrun#202 ·
-
question raised-by:verifier
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
medici-finance/assay#4013 ·
Los mantenedores suelen responder en 1 día
-
TestRegistry_ConcurrentMixedOperations fetches from the network and can hang the short suiteAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 83/100
tsukumogami/tsuku#2775 ·
Los mantenedores suelen responder en 1 día
-
automation models
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 69/100
Los mantenedores suelen responder en 1 día