stackabletech / stackabletech/documentation
Operator overview pages for internal operators (commons, secret, listener)
Ouverte
Personne n'a encore pris cette issue.
area/documentation
size/M
- Langage dominant
- CSS
- Étoiles
- 13
- Forks
- 14
- Merge moyen
- 4 j 8 h
- PR mergées (30 j)
- 10
Description
Follow up to https://github.com/stackabletech/documentation/issues/282
Explain for every operator:
- which roles does it have and what do they mean?
- Which resources does it create:
- i.e. statefulsets per role
- configmap for discovery
- also a diagram
- which resources does it tear down again?
- for example, ConfigMaps and PVCs are staying
- what are the dependencies, what other operators does it connect to?
- link to demos
Operators:
- commons
- secret
- listener
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire l'issue de suivi #282 et examinez la documentation existante des opérateurs commons, secret et listener. Pour chaque opérateur, documentez ses rôles, les ressources créées et conservées ou supprimées, les dépendances, les diagrammes et les liens vers les démos. Le travail est terminé lorsque les cases à cocher des trois opérateurs sont couvertes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100