loopbackio / loopbackio/loopback-next

[Docs] Example config.json for `lb4 <command>` except `lb4 app` shows the app-config.json

Offen
#1,844 5 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Docs good first issue
Vorherrschende Sprache
TypeScript
Sterne
5.1k
Forks
1.1k
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
27

Beschreibung

## Description / Steps to reproduce / Feature proposal
In the CLI generator docs e.g. https://loopback.io/doc/en/lb4/Model-generator.html, the example `--config` option shows the `lb4 app` example. This is true for Application, Datasource, Repository, etc. generators (7 generators in total).

## Expected Behavior
We should show the appropriate config json file that the commands are expecting. Find a dynamic way to update https://github.com/strongloop/loopback-next/blob/master/docs/site/includes/CLI-std-options.md for each command.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit docs/site/includes/CLI-std-options.md und vergleiche dessen --config-Beispiel mit der Dokumentation zum CLI-Generator, einschließlich der sieben im Issue genannten Generatoren. Ermittle, wie das erwartete Config-JSON jedes Befehls dargestellt wird, aktualisiere anschließend die Dokumentation, sodass jeder Befehl das passende Beispiel zeigt, und überprüfe die betroffenen Generatorseiten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
cli, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.