Investigate how to build other REST API generated docs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- openapi
调研方向
首先查看链接的 KC 页面上的 OpenAPI REST API 文档以及 autogen epic (#2615)，以确定 Batch REST APIs 和 JMX REST Connector REST APIs 当前是如何构建的。与 Michal 和 Alasdair 讨论调查结果；完成的标准是记录构建方法，并创建一个已确定优先级的后续 issue，以便将这些文档集成到 Open Liberty 文档中。
由索引模型根据 Issue 内容生成。
描述
As well as the Liberty API/SPI docs that we've discussed previously (and mentioned in the autogen epic), there are some OpenAPI REST API docs in the KC that Alasdair has previously said do need to come over the OL docs. These are API docs generated by OpenAPI for APIs that are provided to use with Liberty (Batch REST APIs, and JMX REST Connector REST APIs) (so, to be clear, this has nothing to do with the OL support for MicroProfile OpenAPI etc).
Alasdair's comment when we first audited the KC, was that we need to start by finding out how the KC is currently building these docs. Then, talk to Michal about how we get these docs built into the OL docs, and will probably need an issue creating then like we have for the API/SPI docs. That issue should probably be added to the autogen epic and prioritised with Alasdair against the other issues listed there.
- 主要语言
- 没有语言数据
- 星标
- 14
- 派生
- 58
- 平均合并
- 1 小时
- 30 天内合并 PR
- 25
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
OpenLiberty/docs 的其他 Issue
-
**DRAFT** Document Replace the Channel Framework with Netty可能已有人在做 @mrsaldana 于 13 天前认领。 未关闭
OpenLiberty/docs#8586 · 已指派 3 人 ·
维护者通常 1 天内回复
-
26.0.0.12
难度 5/5 一周以上 新手友好度 25/100
OpenLiberty/docs#8548 ·
维护者通常 1 天内回复
-
Documentation, JWT Builder Workload Identity and JWK Rotation可能已有人在做 @ramkumar-k-9286 于 4 天前认领。 未关闭26.0.0.12
难度 4/5 3-5 天 新手友好度 45/100
OpenLiberty/docs#8529 · 6 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Document the new set of Liberty container images based on UBI Micro (26.0.0.9)可能重新可做 @jantley-ibm 于 85 天前认领，目前没有进行中的 PR。 未关闭26.0.0.12
OpenLiberty/docs#8499 · 8 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 48/100
OpenLiberty/docs#8336 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 88/100
sandialabs/atlas-ui-3#1196 ·
维护者通常 1 天内回复
-
style: article/section 📝 system: bcm11_update
难度 2/5 1-3 小时 新手友好度 66/100
uabrc/uabrc.github.io#1271 · 1 条评论 ·
-
area: mobile chore good first issue
难度 2/5 1-3 小时 新手友好度 76/100
CommandLineCoding/Elephant#247 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 2 天内回复
-
难度 1/5 1 小时以内 新手友好度 68/100
Sendspin/sendspin-cpp#257 ·
维护者通常 1 天内回复