Add an `Example` field to the mixlib-cli spec
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- ruby
- Domaine
- cli, documentation
Piste de recherche
Commencez par localiser la spécification des options de mixlib-cli et les chemins des formateurs mentionnés dans l’issue. Suivez la manière dont les métadonnées des options sont émises sur la ligne de commande et dans la sortie .rst ou .md, puis définissez le comportement du champ Example et vérifiez que les exemples de ligne de commande sont correctement pris en charge dans chaque format de sortie.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Ruby
- Étoiles
- 118
- Forks
- 40
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de chef/mixlib-cli
-
Triage: Feature Request
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
chef/mixlib-cli#70 ·
-
Long options that start with `--no-*` are negated even when its explicitly defined as an optionOuverteType: Bug
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
chef/mixlib-cli#48 · 1 commentaire ·
-
Option validationsOuverteTriage: Feature Request
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
chef/mixlib-cli#38 · 1 commentaire ·
-
Triage: Feature Request
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
chef/mixlib-cli#27 ·
Toutes les issues de chef/mixlib-cli
Issues similaires
-
agent:triaged bug bughunt pm:bundler priority:p1
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
SocketDev/socket-patch#1573 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
bug chat verified
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 6 jours
-
🐞 bug pending triage
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
CircuitVerse/CircuitVerse#8031 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Empty members in the Accept header cause a 500Peut-être pris @koic l’a pris aujourd’hui. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
modelcontextprotocol/ruby-sdk#609 ·
Les mainteneurs répondent en général sous 1 jour
-
BazaRb::Fake#enter rejects dotted badges accepted by BazaRb#enterPeut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 1/5 1-3 heures Accessibilité débutants 84/100
Les mainteneurs répondent en général sous 1 jour