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

Create images for illustrating the structure and workflow

オープン
#45 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
8
フォーク
4
平均マージ
2日 3時間
マージ済み PR(30日)
1

説明

## 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 SDK のドキュメントと、issue にリンクされている Ankaios drawio の例を確認します。コミッターとユースケースおよび図について話し合って合意し、その後、それらを生成する方法を選択します。SDK の構造とワークフローが図示され、ドキュメントと README への統合が任意で行われれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。