Use EESSI Action and Quarto to give more dynamic documentation
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
The issue proposes adding the mkquartodocs MkDocs plugin (linked on PyPI) so Quarto documents can run commands like the EESSI host_injections scripts and show their output. Start by reading the Quarto execution-options page it links and checking how the docs site is built and deployed with the EESSI Action. Done means one docs page renders live EESSI stack output at build time. The issue has no comments or owner, so confirm the approach with maintainers before starting.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
With Quarto documents you can create dynamic output from bash, python, etc. (see https://quarto.org/docs/computations/execution-options.html#output-options). Together with our GitHub Action, this gives us scope to dynamically include information from the EESSI stack (think host_injections scripts, what initialisation looks like,...)
MkDocs has a plugin to support this: https://pypi.org/project/mkquartodocs/
- Lenguaje dominante
- Python
- Estrellas
- 14
- Forks
- 54
- Merge medio
- 11 h 2 min
- PR fusionados (30 d)
- 41
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 EESSI/docs
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
EESSI/docs#949 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
add "talks" sectionAbierto
Dificultad 2/5 Medio día Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
Todos los issues de EESSI/docs
Issues similares
-
ChatBedrockConverse changes the keys of JSON tool results to camelCase (`order_id` becomes `orderId`)Posiblemente ocupada @geyazheng la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
langchain-ai/langchain-aws#1469 ·
Los mantenedores suelen responder en 1 día
-
b4b usability
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
fix(schedule): align list_tasks since cursor filter boundary from strict > to >=Posiblemente ocupada @bfs2021 la tomó hoy. Abiertoagent-ready bug p2 schedule
Dificultad 2/5 1-3 horas Aptitud para principiantes 83/100
allenporter/supernote#540 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
frazane/scoringrules#164 ·
Los mantenedores suelen responder en 1 día
-
The docs build fails: ecc's live inventory dropped the ecc.ecc names btclib's pinned ecc usesPosiblemente ocupada @fametrano la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
btclib-org/btclib#2968 ·
Los mantenedores suelen responder en 1 día