angular / angular/angular-cli

Generate documentation for default builders

Offen
#23,088 7 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
area: @angular-devkit/build-angular area: docs
Vorherrschende Sprache
TypeScript
Sterne
27k
Forks
11.8k
Ø Merge
14 Std. 23 Min.
Gemergte PRs (30 T.)
162

Beschreibung

AIO has a page on `angular.json` workspace configuration which lists [default builders](https://angular.io/guide/workspace-config#default-architect-builders-and-targets). Unfortunately these builders link directly to the [JSON schema](https://github.com/angular/angular-cli/blob/main/packages/angular_devkit/build_angular/src/builders/browser/schema.json), which is not very intuitive.

We should process these schema files and generate a page for each builder linked from the workspace configuration. This would make it much easier to understand `@angular-devkit/build-angular` and related builders' options.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der AIO-Arbeitsbereichskonfigurationsseite und dem verknüpften Standardschema des Builders, packages/angular_devkit/build_angular/src/builders/browser/schema.json. Verfolge, wie die Schemadateien zu Dokumentationsseiten verarbeitet und von der Liste der Standard-Builder verlinkt werden könnten. Als erledigt gilt die Aufgabe, wenn jeder relevante Builder eine verständliche generierte Seite hat und die Arbeitsbereichskonfiguration auf diese Seiten statt direkt auf JSON-Schemas verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, typescript
Bereich
build-system, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 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.