stackabletech / stackabletech/documentation
CRD doc generation leads to bad formatting
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
E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).
Possible fixes:
- We can try to remove that doc comment from rendering
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 la section CRD NiFi rendue à l’URL crds.stackable.tech indiquée et déterminez comment la documentation de Quantity est produite. Suivez cette entrée dans le flux de génération de la documentation, puis vérifiez que les champs Quantity concernés sont rendus sans le mauvais formatage dans la documentation CRD générée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- kubernetes
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100