jsdocs are not getting published
还没有人认领这个 Issue。
评估
- 难度
- 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 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
hyperledger/fabric-chaincode-node 的其他 Issue
-
Read/write batching可能重新可做 @Vineet1101 于 249 天前认领，目前没有进行中的 PR。 未关闭enhancement help wanted
hyperledger/fabric-chaincode-node#453 · 7 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
hyperledger/fabric-chaincode-node#321 · 2 条评论 ·
查看 hyperledger/fabric-chaincode-node 的全部 Issue
相似的 Issue
-
status: waiting for maintainer
难度 2/5 1-3 小时 新手友好度 74/100
mui/material-ui#49547 ·
维护者通常 1 天内回复
-
[2.x] extension-manager: translation keys that changed meaning keep their old names可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭type/bug
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 66/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
rescript-lang/rescript#8996 ·
维护者通常 1 天内回复