Use EESSI Action and Quarto to give more dynamic documentation
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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/
- Langage dominant
- Python
- Étoiles
- 14
- Forks
- 54
- Merge moyen
- 11 h 2 min
- PR mergées (30 j)
- 41
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de EESSI/docs
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
EESSI/docs#949 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Les mainteneurs répondent en général sous 1 jour
-
good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
add "talks" sectionOuverte
Difficulté 2/5 Une demi-journée Accessibilité débutants 62/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de EESSI/docs
Issues similaires
-
ChatBedrockConverse changes the keys of JSON tool results to camelCase (`order_id` becomes `orderId`)Peut-être pris @geyazheng l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
langchain-ai/langchain-aws#1469 ·
Les mainteneurs répondent en général sous 1 jour
-
b4b usability
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
fix(schedule): align list_tasks since cursor filter boundary from strict > to >=Peut-être pris @bfs2021 l’a pris aujourd’hui. Ouverteagent-ready bug p2 schedule
Difficulté 2/5 1-3 heures Accessibilité débutants 83/100
allenporter/supernote#540 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
frazane/scoringrules#164 ·
Les mainteneurs répondent en général sous 1 jour
-
The docs build fails: ecc's live inventory dropped the ecc.ecc names btclib's pinned ecc usesPeut-être pris @fametrano l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
btclib-org/btclib#2968 ·
Les mainteneurs répondent en général sous 1 jour