eclipse-ankaios / eclipse-ankaios/ank-sdk-python

Create images for illustrating the structure and workflow

Đang mở
#45 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
Python
Star
8
Fork
4
Merge trung bình
2 ngày 3 giờ
Pull request đã merge (30 ngày)
1

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.