Improve docs authoring experience
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation, tooling
Línea de trabajo
Comienza revisando la extensión Antora Atlas y la extensión para builds parciales enlazadas en el issue, y después examina el workflow actual de build de la documentación. Define cómo afectarían el almacenamiento en caché de los bundles de UI y los builds parciales a la configuración de dos repositorios; se considerará terminado cuando exista un workflow de authoring documentado y funcional con tiempos de build más cortos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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)
- Lenguaje dominante
- CSS
- Estrellas
- 13
- Forks
- 14
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 10
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de stackabletech/documentation
-
Withdraw ADR018 Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
stackabletech/documentation#734 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
stackabletech/documentation#779 ·
-
customer-request
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
stackabletech/documentation#773 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
stackabletech/documentation#754 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
stackabletech/documentation#753 ·
Todos los issues de stackabletech/documentation
Issues similares
-
triage
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
feature pydanty:is-working
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
pydantic/pydantic-ai#8647 ·
-
Add date o "release information" Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Add more to the documentation Abierto:watch: Not Triaged dotnet-fsharp/svc
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100