Add an `Example` field to the mixlib-cli spec
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- cli, documentation
調査の方向性
まず、issue で言及されている mixlib-cli のオプション仕様と formatter のパスを見つけます。オプションのメタデータがコマンドライン上および .rst または .md の出力にどのように出力されるかを追跡し、次に Example フィールドの動作を定義して、各出力形式でコマンドラインの例が正しく処理されることを確認します。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- Ruby
- スター
- 118
- フォーク
- 40
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
chef/mixlib-cli のほかの issue
-
Triage: Feature Request
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
chef/mixlib-cli#70 ·
-
Long options that start with `--no-*` are negated even when its explicitly defined as an optionオープンType: Bug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
chef/mixlib-cli#48 · コメント 1 件 ·
-
Option validationsオープンTriage: Feature Request
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
chef/mixlib-cli#38 · コメント 1 件 ·
-
Triage: Feature Request
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
chef/mixlib-cli#27 ·
chef/mixlib-cli の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
TheOdinProject/curriculum#31467 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
message-patterns
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
sisimai/rb-sisimai#468 ·
-
202610-volunteers my-first-pr PROJECT: website-redesign
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
thewca/worldcubeassociation.org#16072 ·
メンテナーはふだん 1 日以内に返信