Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Pré-filtrer les fichiers d'exemple à télécharger #21

Open
marc-bouvier opened this issue Nov 29, 2023 · 12 comments
Open

[Doc] Pré-filtrer les fichiers d'exemple à télécharger #21

marc-bouvier opened this issue Nov 29, 2023 · 12 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@marc-bouvier
Copy link
Contributor

marc-bouvier commented Nov 29, 2023

Pour éviter une modification fastidieuse à chaque démarrage d'audit, proposer des fichiers d'exemple pour les audits 25, 50, 81 critères en plus des fichiers avec tous les critères.

Ceci peut être automatisé à l'aide d'un script shell comme le suivant :

rm -rf out
mkdir out

curl  https://raw.githubusercontent.com/lowdit/frago/master/exampleSite/exampleFiles/grille-criteres-rgaa-4.csv --output grille-criteres-rgaa-4.csv

curl https://raw.githubusercontent.com/lowdit/frago/master/exampleSite/exampleFiles/grille-tests-rgaa-4.0.csv --output grille-tests-rgaa-4.0.csv

curl  https://raw.githubusercontent.com/lowdit/frago/master/exampleSite/exampleFiles/grille-tests-rgaa-4.1.csv --output grille-tests-rgaa-4.1.csv

cat grille-criteres-rgaa-4.csv| grep -E '25|Thématique' > out/grille-criteres-rgaa-4_25.csv
cat grille-criteres-rgaa-4.csv| grep -E '25|50|Thématique' > out/grille-criteres-rgaa-4_50.csv
cat grille-criteres-rgaa-4.csv| grep -E '25|50|81|Thématique' > out/grille-criteres-rgaa-4_81.csv
cat grille-criteres-rgaa-4.csv > out/grille-tests-rgaa-4_all.csv
    
cat grille-tests-rgaa-4.0.csv | grep -E '25|Thématique' > out/grille-tests-rgaa-4.0_25.csv
cat grille-tests-rgaa-4.0.csv | grep -E '25|50|Thématique' > out/grille-tests-rgaa-4.0_50.csv
cat grille-tests-rgaa-4.0.csv | grep -E '25|50|81|Thématique' > out/grille-tests-rgaa-4.0_81.csv
cat grille-tests-rgaa-4.0.csv > out/grille-tests-rgaa-4.0_all.csv

cat grille-tests-rgaa-4.1.csv | grep -E '25|50|81|Thématique' > out/grille-tests-rgaa-4.1_81.csv
cat grille-tests-rgaa-4.1.csv | grep -E '25|50|Thématique' > out/grille-tests-rgaa-4.1_50.csv
cat grille-tests-rgaa-4.1.csv | grep -E '25|Thématique' > out/grille-tests-rgaa-4.1_25.csv
cat grille-tests-rgaa-4.1.csv > out/grille-tests-rgaa-4.1_all.csv

Ce script pourrait être exécuté dans la pipeline qui publie la doc.

https://github.com/lowdit/frago/blob/docs/.github/workflows/gh-pages.yml

@marc-bouvier marc-bouvier added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 29, 2023
@marc-bouvier
Copy link
Contributor Author

Fait.

image

@marc-bouvier
Copy link
Contributor Author

Finalement, je les ai présentées sur 1 seule ligne.

image

@bertrandkeller
Copy link
Contributor

Si ça te botte, il existe une branche script : https://github.com/lowdit/frago/tree/scripts

On peut tout faire dedans. C'est le royaume du bash. On peut créer un bash avec des choix multiples. Je trouve ça vraiment classe avec des couleurs.

On peut créer des issues pour pas mal d'usages. Et ajouter une page dans la documentation.

@marc-bouvier
Copy link
Contributor Author

Ah ouais! pour celleux qui veulent générer des trucs à l'aide de bash!

@bertrandkeller
Copy link
Contributor

Gros enjeux qui peut permettre à des novices d'avoir accès à plein de trucs sympas.
Normalement bash est dispo sur les machines Windows (?)

On peut imaginer appeler des API ou workers.

@marc-bouvier
Copy link
Contributor Author

marc-bouvier commented Nov 29, 2023

Sur Windows, on utiliserait plutôt Powershell (qui fonctionne maintenant sur linux/macos également) par contre pas forcément très utilisé.

Si on veut faire des CLI pour plusieurs OS faciles à installer, ces dernières années on voit apparaitre des choses en Go, Rust, et parfois javascript.

Une fois packagé, ca fait un binaire unique qu'on peut télécharger.

Ca serait assez sexy pour les populations de développeurs d'avoir une cli frago. Ca pourrait amener de nouveaux gens à adhérer au projet.

Outils pour développer des outils CLI : https://github.com/shadawck/awesome-cli-frameworks

  • Certains langages permettent de produire des binaires qui sont auto suffisants (ex. Go, Rust, C) ce qui permettrait d’en faciliter l’installation et l’utilisation par des profils peu techniques

Autre approche : outils de scaffolding basés sur des templates

@bertrandkeller
Copy link
Contributor

Il faut garder une approche grand, grand débutant. C'est le public visé.
Le reste c'est du plus.

Tu as un référent qui fait pas de ligne de commande, mais peut copier/coller une ligne. Et qui doit convaincre un "dev" (tu as tous les niveaux) qui doit installer ça sur une CI ou équivalent.

C'est le besoin.

@bertrandkeller
Copy link
Contributor

Tu peux proposer des PR, je validerai.

@marc-bouvier
Copy link
Contributor Author

l faut garder une approche grand, grand débutant. C'est le public visé.

C'est ce que j'avais compris effectivement. Merci de le confirmer à nouveau.

@bertrandkeller
Copy link
Contributor

Faut faire une autre "issue" pour la CLI.

Y aurait peut-être des trucs très intéressants à faire. Notamment en lien avec l'observatoire.
Un template Eleventy que j'ai codé pour aller appeler plusieurs Frago et aggréger de la donnée.

On pourrait lancer des tâches avant et après.

Avant pour convertir peut-être du YAML en JSON. Et voir si parser du JSON pour Hugo n'est pas plus rapide dans le cas ou il y aurait des centaines d'audits…

Après pour soumettre les données de l'API à l’observatoire…

Bref… faudrait faire un schéma de la données entre sa création et son exploitation dans un autre cadre (type observatoires).

@marc-bouvier
Copy link
Contributor Author

@bertrandkeller peux tu donner un peu plus d'informations à propos de l'observatoire ? Je ne suis pas sur de savoir de quoi tu parles.

@bertrandkeller
Copy link
Contributor

Ce que j'appelle observatoire ressemble à ça : https://metago.netlify.app/
(j'ai du reprendre tout le site car j'arrivais pas à gérer la mise à jour avec node…)

Ça appelle des api de différents Frago et ça génère un site qui affiche les résultats.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants