Improve docs authoring experience
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 30/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- À l'abandon
- Domaine
- documentation, tooling
Piste de recherche
Commencez par examiner l’extension Antora Atlas et l’extension de builds partiels liées dans l’issue, puis examinez le workflow actuel de build de la documentation. Définissez l’impact du caching des bundles d’UI et des builds partiels sur la configuration à deux repositories ; le travail sera considéré comme terminé lorsqu’un workflow d’authoring documenté et fonctionnel, avec des temps de build plus courts, sera disponible.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.
Currently the workflow is:
- checkout both the docs repo and the operator repo
- edit the playbook file to point to the local operator repo checkout
- write the docs in the operator repo and rebuild the docs periodically
Main pain points are:
- the setup is cumbersome
- build times are long
### Tasks
- [ ] Cache UI bundle in the build
- [ ] investigate Atlas/partial build extension
Links:
- Antora Atlas extension: https://gitlab.com/antora/antora-atlas-extension
- partial build extension: https://github.com/spring-io/antora-extensions#partial-build (depends on the Atlas extension)
- Langage dominant
- CSS
- Étoiles
- 13
- Forks
- 14
- Merge moyen
- 4 j 8 h
- PR mergées (30 j)
- 10
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.
Autres issues de stackabletech/documentation
-
Withdraw ADR018 Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
stackabletech/documentation#734 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
stackabletech/documentation#779 ·
-
customer-request
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
stackabletech/documentation#773 ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
stackabletech/documentation#754 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 25/100
stackabletech/documentation#753 ·
Toutes les issues de stackabletech/documentation
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
git/git-scm.com#2207 ·
-
link-check link-check:sphinx-theme
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
qgis/QGIS-Documentation#11275 ·
-
Change observation tooltip text Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
CSCfi/sd-search-api#39 ·
-
sync-en
Difficulté 1/5 1-3 heures Accessibilité débutants 85/100