Automatically Generate Documentation for Queries in Query Library Based on their YAML
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- github-actions, yaml
- Ambito
- ci-cd, documentation, release
Direzione di ricerca
Inizia individuando i file YAML della libreria di query e la cartella docs esistente. Definisci il template Markdown e la GitHub Action attivata da una nuova release attorno al flusso YAML-to-Markdown proposto; il lavoro è completato quando ogni query ha una documentazione Markdown generata dopo una nuova release.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Problem Statement
Currently, every query in our query library is associated with a YAML file. This file outlines essential details like the query's function, parameters, references, etc. Additionally, we have more comprehensive documentation for these queries and exploits in the docs folder.
Creating markdown documentation can be a time-consuming task. While we don't want this to discourage contributions, all queries must be documented. Therefore, we must balance accessibility for contributors with the necessity for thorough documentation.
Proposed Solution
Automate the generation of Markdown documentation for each query in the query library based on its YAML file. This should be triggered on each new release to ensure the documentation is always up-to-date with the latest queries.
Technical Details
Event Trigger:
New GitHub push/ push to query library/ release
Process:
Read the YAML files of the queries in the query library.
Use a predefined Markdown template.
Unpack the YAML data into the Markdown template.
Save the new Markdown files in a documentation directory.
We can possibly do it with a github action.
What do you think?
- Lingua principale
- Python
- Stelle
- 748
- Fork
- 46
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di CycodeLabs/raven
-
`library` folder not included in the source distributionForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertaquery-library
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
CycodeLabs/raven#183 · 2 commenti ·
-
报错Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 15/100
CycodeLabs/raven#199 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
CycodeLabs/raven#188 · 2 commenti · 1 reazione ·
-
feature
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
CycodeLabs/raven#119 · 6 commenti ·
-
feature indexer
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
CycodeLabs/raven#114 ·
Tutte le issue di CycodeLabs/raven
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
mishraprafful/multihull#150 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
python-caldav/caldav#735 ·
I maintainer di solito rispondono entro 1 giorno
-
bug triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
mealie-recipes/mealie#8682 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue lane:repo
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100