Use EESSI Action and Quarto to give more dynamic documentation
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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/
- Linguagem predominante
- Python
- Estrelas
- 14
- Forks
- 54
- Merge médio
- 11h 2min
- PRs com merge (30d)
- 41
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de EESSI/docs
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
EESSI/docs#949 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Mantenedores costumam responder em até 1 dia
-
good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
add "talks" sectionAberta
Dificuldade 2/5 Meio dia Facilidade para iniciantes 62/100
Mantenedores costumam responder em até 1 dia
Issues semelhantes
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
igormcsouza/tether#278 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 91/100
aws-samples/sample-per-model-bedrock#803 ·
Mantenedores costumam responder em até 1 dia
-
documentation p1
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
huggingface/accelerate#4511 ·
Mantenedores costumam responder em até 1 dia
-
follow-up
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia