Create images for illustrating the structure and workflow
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看 Python SDK 文档以及 issue 中链接的 Ankaios drawio 示例。与提交者讨论并就用例和图表达成一致，然后选择一种生成它们的方式；完成的标准是对 SDK 结构和工作流进行了说明，并可选择将其集成到文档和 README 中。
由索引模型根据 Issue 内容生成。
描述
Description
The Python SDK has documentation, and that is a good starting point for accommodating,
but having some images that show details would help in better understanding the sdk.
For instance, there can be an image illustrating the inner structure of the sdk, a graph with
the classes and the relations between them, or the workflows of different operations:
applying a manifest, creating a workload etc.
Example from Ankaios:
https://github.com/eclipse-ankaios/ankaios/tree/main/api/doc/swdesign/drawio
Goals
Images are created that illustrate how the SDK works.
Final result
Summary
To be filled when the final solution is sketched.
Tasks
- Analize what can be illustrated.
- Find a way to programmatically create the diagrams (see example from main repo).
- Generate the images.
- Optional: Add the images to the documentation and readme.
- 主要语言
- Python
- 星标
- 9
- 派生
- 5
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
eclipse-ankaios/ank-sdk-python 的其他 Issue
-
python-version
难度 2/5 1-3 小时 新手友好度 82/100
-
enhancement good first issue
难度 4/5 3-5 天 新手友好度 48/100
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
eclipse-ankaios/ank-sdk-python#99 · 1 条评论 ·
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
enhancement good first issue
难度 4/5 3-5 天 新手友好度 35/100
查看 eclipse-ankaios/ank-sdk-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
WingedGuardian/GENesis-AGI#3375 ·
维护者通常 1 天内回复
-
curriculum documentation quality
难度 2/5 1-3 小时 新手友好度 75/100
githubnext/gh-aw-workshop#4601 ·
维护者通常 1 天内回复
-
approved Good First Issue scope: docs
难度 1/5 1 小时以内 新手友好度 85/100
hiero-ledger/hiero-sdk-python#2730 · 3 条评论 ·
维护者通常 1 天内回复