Create images for illustrating the structure and workflow
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng việc xem xét tài liệu Python SDK và ví dụ Ankaios drawio được liên kết trong issue. Thảo luận và thống nhất về các trường hợp sử dụng cũng như sơ đồ với các committer, sau đó chọn một cách để tạo chúng; được coi là hoàn tất khi cấu trúc SDK và các workflow được minh họa, với tùy chọn tích hợp vào tài liệu và README.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Python
- Star
- 8
- Fork
- 4
- Merge trung bình
- 1 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 3
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của eclipse-ankaios/ank-sdk-python
-
Update Python support to 3.15Có thể đã có người làm @meheraz1100 đã nhận 1 ngày trước. Đang mởpython-version
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
eclipse-ankaios/ank-sdk-python#158 · 1 bình luận · 1 người được giao ·
-
Update Python support to 3.14Đang mởpython-version
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
enhancement good first issue
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
-
enhancement
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
eclipse-ankaios/ank-sdk-python#99 · 1 bình luận ·
-
Document the release processĐang mởenhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
Tất cả issue của eclipse-ankaios/ank-sdk-python
Issue tương tự
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
gradio-app/gradio#13964 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 93/100
BSData/horus-heresy-3rd-edition#3232 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
jbacalso24/mimry#123 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
p:3-mid pydanty:bug pydanty:is-working
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
pydantic/pydantic-ai#10153 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
good first issue priority: medium size: S testing
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
cubrid-lab/cubrid-cookbook-python#316 ·
Maintainer thường phản hồi trong vòng 1 ngày