chef / chef/mixlib-cli

Add an `Example` field to the mixlib-cli spec

Open
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Triage: Feature Request
Dominant language
Ruby
Stars
118
Forks
40
PR merge metrics
No merged PRs in 30d

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the mixlib-cli option spec and the formatter paths mentioned in the issue. Trace how option metadata is emitted on the command line and into .rst or .md output, then define the Example field behavior and verify that command-line examples are handled correctly in each output format.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.