stackabletech / stackabletech/documentation
Operator env vars documentation
Personne n'a encore pris cette issue.
- Langage dominant
- CSS
- Étoiles
- 13
- Forks
- 14
- Merge moyen
- 4 j 8 h
- PR mergées (30 j)
- 10
Description
currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.
The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)
These things should go into the Reference section.
We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.
related: https://github.com/stackabletech/documentation/issues/514
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 localiser la documentation existante, rédigée manuellement, sur les variables d’environnement et les paramètres de ligne de commande, puis examinez les sections Reference et l’issue associée 514. Le travail est terminé lorsque les paramètres sont documentés sous une forme que les utilisateurs peuvent appliquer avec Helm ou OpenShift, et que toute décision concernant les partials partagés ou la génération est consignée dans la documentation résultante.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- helm
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100