ember-learn / ember-learn/ember-jsonapi-docs

Docs processing fails silently.

Aperta
#98 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
10
Fork
11
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The below appears successful even though it failed to generate any docs. ember-data is locally available, the version matches as expected, and the docs file is generated at data/packages/-ember-data/dist/docs/data.json as expected.

```cli
yarn gen --project ember-data --version 3.28.0 ~/github/oss/ember-jsonapi-docs  master
yarn run v1.22.5
$ node -r esm generate-local.js --project ember-data --version 3.28.0
Running 'yarn'
[1/5] Validating package.json...
[2/5] Resolving packages...
success Already up-to-date.

Running 'yarn workspace ember-data docs'
$ mkdir -p dist && ember ember-cli-yuidoc
info: Scanning for yuidoc.json file.
info: Loading package.json data from: /Users/runspired/github/oss/data/packages/-ember-data/package.json
info: Loading yuidoc.json data from: /Users/runspired/github/oss/data/packages/-ember-data/yuidoc.json
info: YUIDoc Starting from: ../adapter/addon,../canary-features/addon,../debug/addon,../model/addon,../private-build-infra/addon,../record-data/addon,../serializer/addon,../store/addon,addon
Filtering tags...
Skipping items with the tags: internal
info: Making out dir: dist/docs
info: Parsed 144 files in 0.096 seconds
info: Building..
info: Compiling Templates
info: Making default directories: classes,elements,modules,files
info: Copying Assets
info: Rendering and writing 14 modules pages.
info: Loading theme from /Users/runspired/github/oss/data/node_modules/yuidocjs/themes/default/theme.json
info: Preparing index.html
info: Writing API Meta Data
info: Writing index.html
info: Finished writing module files
info: Rendering and writing 51 class pages.
info: Rendering and writing 0 class pages.
info: Finished writing element files
info: Rendering and writing 82 source files.
info: Finished writing class files
info: Rendering and writing 82 source files.
info: Finished writing source files
info: Finished writing source files
info: Finished writing 230 files in 0.864 seconds

$ node index.js --project ember-data --version 3.28.0 --ignorePreviouslyIndexedDoc --no-sync
Skipping downloading docs
tmp/json-docs/ember-data/projects/ember-data.json false
Starting to process ember-data-3.28.0
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con generate-local.js e index.js, quindi riproduci il comando yarn gen --project ember-data --version 3.28.0 usando l’output documentato. Traccia il percorso di elaborazione della documentazione intorno al file JSON di ember-data segnalato e considera completato il lavoro quando il comando segnala chiaramente il fallimento invece di sembrare riuscito.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
build-system, documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.