stackabletech / stackabletech/documentation
Improve docs authoring experience
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- CSS
- Sterne
- 13
- Forks
- 14
- Ø Merge
- 4 T. 8 Std.
- Gemergte PRs (30 T.)
- 10
Beschreibung
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)
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Prüfung der in der Issue verlinkten Antora Atlas-Erweiterung und der Erweiterung für partielle Builds und untersuche anschließend den aktuellen Workflow für den Dokumentations-Build. Lege fest, wie sich das Caching von UI-Bundles und partielle Builds auf das Setup mit zwei Repositories auswirken würden; als abgeschlossen gilt die Arbeit, wenn ein dokumentierter, funktionierender Authoring-Workflow mit kürzeren Build-Zeiten vorhanden ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100