Docs processing fails silently.
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- build-system, documentation
Research direction
Start with generate-local.js and index.js, then reproduce the yarn gen --project ember-data --version 3.28.0 command using the documented output. Trace the docs-processing path around the reported ember-data JSON file and define done as the command clearly reporting the failure instead of appearing successful.
Written by the indexing model from the issue text.
Description
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.
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.
- Dominant language
- JavaScript
- Stars
- 10
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ember-learn/ember-jsonapi-docs
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
ember-learn/ember-jsonapi-docs#141 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 40/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
ember-learn/ember-jsonapi-docs#75 · 11 comments · 2 assignees ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ember-learn/ember-jsonapi-docs#74 · 3 comments ·
All issues in ember-learn/ember-jsonapi-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NationalSecurityAgency/skills-service#4052 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 88/100
githubnext/gh-aw-workshop#4251 ·
Maintainers usually reply within 1 day
-
customer-support needs-triage Platform(Default)
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Leonxlnx/taste-skill#129 ·
Maintainers usually reply within 1 day