Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Docs processing fails silently.

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript

調査の方向性

generate-local.js と index.js から始め、次に文書化された出力を使って yarn gen --project ember-data --version 3.28.0 コマンドを再現します。報告された ember-data JSON ファイル周辺のドキュメント処理パスを追跡し、コマンドが成功したように見えるのではなく、失敗を明確に報告することを完了条件とします。

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

説明

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.
主要言語
JavaScript
スター
10
フォーク
11
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

ember-learn/ember-jsonapi-docs のほかの issue

ember-learn/ember-jsonapi-docs の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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