jsdocs are not getting published
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- github-actions, javascript
- 領域
- ci-cd, documentation
調査の方向性
まず、ci/azure-pipelines.yml の 218-283 行目にある jsdoc の公開手順を、現在の GitHub Actions ワークフローと比較します。docs/_jsdoc/tutorials/using-contractinterface.md のソースと対応する gh-pages の出力を確認し、公開されたページで現在の fabric-contract-api バージョンが使用されていることを検証します。重複している TUTORIAL.md の内容を残すべきか削除すべきかを明確にします。
索引モデルが issue の本文から書いたものです。
説明
The jsdocs are no longer getting published.
For example the source file:
https://github.com/hyperledger/fabric-chaincode-node/blob/main/docs/_jsdoc/tutorials/using-contractinterface.md
Should get pushed to gh-pages branch here:
https://github.com/hyperledger/fabric-chaincode-node/blob/gh-pages/main/api/tutorial-using-contractinterface.html
Which then gets rendered here:
https://hyperledger.github.io/fabric-chaincode-node/main/api/tutorial-using-contractinterface.html
Look at the "fabric-contract-api" version in the above pages, you'll see the first link references 2.5.0 while the latter links still reference the outdated 2.4.1.
It looks like the jsdocs used to get published in the Azure Pipelines job at:
https://github.com/hyperledger/fabric-chaincode-node/blob/main/ci/azure-pipelines.yml#L218-L283
However, when Azure Pipelines was replaced by GitHub Actions, it looks like the jsdoc job did not get migrated over.
@mbwhite @bestbeforetoday I assume we should still be publishing the jsdocs as part of the GitHub Actions? What trigger would be appropriate?
Also, I'm a little confused because the tutorial https://github.com/hyperledger/fabric-chaincode-node/blob/main/TUTORIAL.md looks like a copy paste of https://github.com/hyperledger/fabric-chaincode-node/blob/main/docs/_jsdoc/tutorials/using-contractinterface.md. Should one of them be removed?
- 主要言語
- JavaScript
- スター
- 262
- フォーク
- 147
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
hyperledger/fabric-chaincode-node のほかの issue
-
Read/write batching再び着手できるかも @Vineet1101 が 250 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンenhancement help wanted
hyperledger/fabric-chaincode-node#453 · コメント 7 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
hyperledger/fabric-chaincode-node#321 · コメント 2 件 ·
hyperledger/fabric-chaincode-node の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
oskarrough/dodgethis#115 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefix対応中かも @ItsDeadlyProgrammer が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
appsmithorg/appsmith#42471 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
external-plugin requires-submitter-fixes
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
github/awesome-copilot#5396 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
chenasraf/nextcloud-forum#348 ·
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
melodic-software/claude-code-plugins#9619 ·
メンテナーはふだん 1 日以内に返信