loopbackio / loopbackio/loopback-next

CLI docs: unify reference guides and `lb4 --help`

オープン
#5,774 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

CLI Docs feature help wanted
主要言語
TypeScript
スター
5.1k
フォーク
1.1k
平均マージ
2日 21時間
マージ済み PR(30日)
27

説明

At the moment, we have two different content describing CLI commands:

  • lb4 {command} --help prints content generated by Yeoman based on generator arguments and options
  • Hand-written documentation pages in CLI Reference section, e.g. DataSource generator

It would be great to unify these two kinds of resources into a single source. (This idea was originally mentioned by @raymondfeng.)

For example, we can maintain CLI help in Markdown format and use a module like marked-terminal to allow lb4 --help to render the documentation to terminal. (Tangentially related: Get rid of Yeoman #844)

This story is a part of #5113 Documentation improvements 2020Q3

Acceptance criteria

TBD - will be filled by the team.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

CLI Reference のページを lb4 {command} --help の出力と比較し、ドキュメント化されている DataSource ジェネレーターと現在の help エントリーポイントから始めます。Markdown ベースの単一のソースを定義し、リファレンスガイドとターミナルヘルプの両方がそれを使用することを検証します。受け入れ基準はまだ確立する必要があります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
nodejs, typescript
領域
cli, documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。