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

Create images for illustrating the structure and workflow

Open
#45 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
8
Forks
4
Avg merge
2d 3h
Merged PRs (30d)
1

Description

## 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.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Python SDK documentation and the Ankaios drawio example linked in the issue. Discuss and agree on the use cases and diagrams with committers, then choose a way to generate them; done means the SDK structure and workflows are illustrated, with optional integration into the documentation and README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.