Add an `Example` field to the mixlib-cli spec
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- ruby
- Área
- cli, documentation
Línea de trabajo
Comienza localizando la especificación de opciones de mixlib-cli y las rutas de los formateadores mencionadas en el issue. Rastrea cómo se emiten los metadatos de las opciones en la línea de comandos y en la salida .rst o .md, luego define el comportamiento del campo Example y verifica que los ejemplos de la línea de comandos se gestionen correctamente en cada formato de salida.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Motivation
As a technical writer
I want to add examples to the CLI docs
so that users will know the tricky bits and we can automate the CLI docs
The documentation team is working towards meaningful automation of our reference documentation (CLI, API, config). Hand-curating CLI examples and scattering them throughout the documentation by means of dtags, partials, or includes makes the documentation lifecycle difficult to manage. Adding an example field that can handle (or, at the very least, ignore) command line examples such as --bootstrap-vault-json '{ "vault1": ["item1", "item2"], "vault2": "item2" }' would help both users and the docs team.
Specification
:example - An example showing the syntax to use with this option. Example "--bootstrap-vault-json '{ "vault1": ["item1", "item2"], "vault2": "item2" }' "
Downstream Impact
This would impact the formatter and how we output the CLI docs, both on the command line and into .rst or .md
- Lenguaje dominante
- Ruby
- Estrellas
- 118
- Forks
- 40
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 chef/mixlib-cli
-
Triage: Feature Request
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
chef/mixlib-cli#70 ·
-
Long options that start with `--no-*` are negated even when its explicitly defined as an optionAbiertoType: Bug
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
chef/mixlib-cli#48 · 1 comentario ·
-
Option validationsAbiertoTriage: Feature Request
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
chef/mixlib-cli#38 · 1 comentario ·
-
Triage: Feature Request
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
chef/mixlib-cli#27 ·
Todos los issues de chef/mixlib-cli
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
scanaislop/aislop#482 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
ETQ admin, le select de condition d'une annotation répétable liste les champs publics deux foisAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
demarche-numerique/demarche.numerique.gouv.fr#14301 ·
Los mantenedores suelen responder en 1 día
-
Wrong permissions for sqliteAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
voxpupuli/puppet-powerdns#251 ·