stackabletech / stackabletech/documentation
Explore alternatives to Antora for documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- CSS
- Estrellas
- 13
- Forks
- 14
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 10
Descripción
[!IMPORTANT]
This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.
Acceptance
- List shortcomings of the status-quo (Antora)
- List things we like about the status-quo (Antora)
- Timeboxed trial of select alternatives to understand the tradeoffs
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.
Línea de trabajo
No se mencionan archivos, pruebas ni puntos de entrada. Empieza por registrar el flujo de trabajo de documentación de Antora, separando sus deficiencias de sus puntos fuertes, y después realiza pruebas con límite de tiempo de alternativas seleccionadas y documenta las compensaciones y pérdidas de cada opción.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100