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

Create images for illustrating the structure and workflow

Ouverte
#45 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Python
Étoiles
8
Forks
4
Merge moyen
2 j 3 h
PR mergées (30 j)
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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner la documentation du Python SDK et l’exemple Ankaios drawio lié dans l’issue. Discutez des cas d’utilisation et des diagrammes avec les committers et mettez-vous d’accord à leur sujet, puis choisissez une manière de les générer ; le travail est considéré comme terminé lorsque la structure du SDK et les workflows sont illustrés, avec une intégration facultative dans la documentation et le README.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.