Create sphinx elements for markdown detail design
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 65/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- markdown
- Área
- documentation
Línea de trabajo
Start with score/datarouter/doc/design/logging_architecture.md and inspect the repository's Sphinx documentation entry points to see how existing design documents become linkable elements. Determine whether the markdown should be converted to RST or linked through the current Sphinx setup, then verify that the detailed design is included and traceable from Sphinx.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
What
There are currently some markdown files that explain the detailed design (e.g. https://github.com/eclipse-score/logging/blob/236ae6142efc5f1a2bc34b17a0dc331c5b46f002/score/datarouter/doc/design/logging_architecture.md)
These do not create sphinx elements that can be linked so no architecture traceability.
Acceptance Criteria (DoD)
- Sphinx detailed design is linked.
- Either the markdown is converted to rst or some way of linking sphinx element is done.
How
No response
- Lenguaje dominante
- C++
- Estrellas
- 2
- Forks
- 33
- Merge medio
- 4 d 20 h
- PR fusionados (30 d)
- 23
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
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 eclipse-score/logging
-
Outdated documentation of shared memory API usagePosiblemente ocupada @uwe-martin la tomó hace 7 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
eclipse-score/logging#372 ·
Los mantenedores suelen responder en 2 días
-
Update to Docs-As-Code 8.3.0Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
eclipse-score/logging#339 ·
Los mantenedores suelen responder en 2 días
-
wp:architecture
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
eclipse-score/logging#314 ·
Los mantenedores suelen responder en 2 días
-
wp:architecture
Dificultad 2/5 Medio día Aptitud para principiantes 68/100
eclipse-score/logging#312 ·
Los mantenedores suelen responder en 2 días
-
wp:architecture
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
eclipse-score/logging#310 ·
Los mantenedores suelen responder en 2 días
Todos los issues de eclipse-score/logging
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
enhancement Ready for final check
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
mpogue2/SquareDesk#1818 · 1 comentario ·
-
launch-client --save-creds creates creds/<account>/ with mode 755, not 700Posiblemente ocupada @metis-sprock la tomó hoy. Abiertobacklog bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
EchoTools/nevr-runtime#1471 ·
Los mantenedores suelen responder en 1 día
-
docs: Page not found?Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 66/100
Los mantenedores suelen responder en 2 días
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
iamankushpandit/Gume#231 ·
Los mantenedores suelen responder en 1 día