Git Product home page Git Product logo

guides.etalab.gouv.fr's Introduction

📚 Les guides d'Etalab 📚

Guides d'Etalab

Ce dépôt contient plusieurs guides rédigés par Etalab ainsi que le code utilisé pour fournir un site web présentant ces guides.

Ajouter un guide

Pour ajouter un guide, il suffit d'ajouter un répertoire à la racine du dépôt. Ce répertoire doit contenir un fichier README.md. Le titre de ce fichier définit le titre du guide.

Pour ajouter des chapitres au guide, il suffit d'ajouter des fichiers .md dans le répertoire précédemment créé, par exemple 0-introduction.md. Les titres de ces fichiers définissent les titres des chapitres.

Les chapitres apparaissent par ordre alphabétique dans les menus de navigation. Il est donc conseillé de préfixer le nom de fichier de chaque chapitre par son numéro, par exemple 0-introduction.md, 1-chapitre-1.md...

La page d'accueil et les menus de navigation sont générés automatiquement.

Il est recommandé d'utiliser un permalink dans chaque fichier de chapitre afin d'obtenir des URLs propres et stables même en cas de re-numérotation de chapitres, par exemple pour qualite/1-preparer-le-jeu-de-donnees.md :

---
permalink: /qualite/preparer-le-jeu-de-donnees
---

Par convention, les images des guides sont stockées dans un répertoire images dans le répertoire de chaque guide.

Développement local

Dans la majorité des cas, l'utilisation de GitHub par le biais de son interface web vous suffira. Vous pouvez directement éditer le contenu des guides par le biais de pull-requests et profiter d'une prévisualisation ensuite.

Si nécessaire, voici comment faire tourner ce projet localement :

npm install
npm run dev
open http://localhost:8080

Licence

Le contenu de ce dépôt est publié sous 2 licences.

2019 DINSIC, Etalab.

guides.etalab.gouv.fr's People

Contributors

abulte avatar agarrone avatar akakeronos avatar antoineaugusti avatar bzg avatar dependabot[bot] avatar geoffreyaldebert avatar jdenes avatar kimmontalibet avatar krichtof avatar loco-philippe avatar mathildehg avatar maudetes avatar pierlou avatar pouuub avatar restuccia avatar schignard avatar soizicpenicaud avatar thomasg77 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

guides.etalab.gouv.fr's Issues

Dire "Données" plutôt que "Jeux de données"

La page https://guides.etalab.gouv.fr/accueil.html donne accès à deux guides contenant "Jeux de données" dans leur titre.

  • Quels jeux de données doivent être publiés en open data ?
  • Comment publier des jeux de données sur data.gouv.fr ?

Ces deux guides portent sur les données administratives en général et l'expression "jeux de données" désigne plutôt des données classiques, tabulaires.

Il est souvent difficile de faire comprendre que des "données textuelles" relèvent bien des données administratives à publier en open data. Je suggère simplement de dire "données" à la place de "jeux de données". Si c'est OK pour vous, je fais la PR.

Définition du NER dans le lexique - guide annotation

Salut @KimMontalibet ,

Dans la définition NER du lexique du guide d'annotation, il me semble que la tâche d’attribuer des catégories type "verbe", "adjectif" ou "adverbe" est plutôt la tâche du PoS tagging (laquelle, côté machine learning, est en effet très similaire au NER).

Reconnaissance d'entités nommées

La reconnaissance d'entités nommées, ou Named Entity Recognition (NER) en anglais, est une tâche d'apprentissage supervisée où les données d'entrées sont chacun des mots d'un document et le label qu'on leur attribue est une catégorie sémantique à laquelle il se rattache : par exemple « verbe », « adjectif » ou « adverbe » dans un cas général et « nom », « prénom », « adresse », « date » pour une tâche de pseudonymisation.

Local deployment instructions fail

Hello, I try to clone and to run yarn install but was bitten by this:

00h00m00s 0/0: : ERROR: [Errno 2] No such file or directory: 'install'

Is it on my side or is there something missing in the instructions?

Deux liens pas bons / cassés dans le guide des algorithmes publics

  1. Dans section "les algos publics" https://guides.etalab.gouv.fr/algorithmes/guide/#les-algorithmes-publics-enjeux-et-obligations le lien vers le guide sur l'ouverture des codes sources renvoie vers sa version sur github, ce qui peut être perturbant pour un non informaticien, j'imagine que l'idée est de renvoyer vers le guide sur le site etalab : https://guides.etalab.gouv.fr/logiciels/
  2. Dans section "comment contribuer" https://guides.etalab.gouv.fr/algorithmes/guide/#comment-contribuer le lien "version éditable" vers le guide sur github n'est pas bon.

Référence à un article de la Loi Lemaire à revoir dans le guide sur l'ouverture du code

Bonjour,
La section cadre juridique du guide sur l'ouverture des codes sources fait référence à un l'article 46, II, 4 de la loi pour une République numérique.
Le texte de loi auquel on fait référence contient un article 46 qui ne semble pas avoir de lien direct avec le sujet évoqué. Par ailleurs c'est article ne contient pas d'alinéas II, 4.
Est-ce qu'il n'y a pas une erreur ?
Bien cordialement
FB

Mise en cohérence du guide "qualite / 3-documenter-les-donnees" et du guide "producteurs-schemas"

Dans la construction d'un jeu de données, le guide "qualite / 3-documenter-les-donnees" fait référence à une étape de "description du modèle de données" préalable à celle de documentation d'un schéma de données (mais ne fait pas le lien explicitement avec le guide "producteurs-schemas").

Réciproquement, le guide "producteurs-schemas" ne fait pas référence à l'étape préalable de construction du modèle de données précisée dans le guide "qualite / 3-documenter-les-donnees".

Mon avis :

  • l'étape modèle de données me parait fondamentale car c'est à cette étape que l'on formalise les dépendances qui existent entre données (la notion de modèle de données est générale et ne se limite pas une approche multi-fichiers). C'est aussi un bon outil pour échanger et se comprendre. Les dépendances identifiées dans le modèle de données peuvent ensuite être formalisées dans le schéma de données et vérifiées dans la phase de production des données (cf proposition de méthodologie.
  • Les deux guides se recouvrent en partie, mais sans maintenir la cohérence entre les deux, ce qui brouille le message.
  • Plusieurs solutions sont possibles :
    - fusionner les deux (ce qui revient à intégrer le guide "producteurs-schemas" dans le guide "qualite / 3-documenter-les-donnees"
    - maintenir deux guides mais séparer les concepts : Ne garder dans le premier que la démarche, le processus et la méthodologie générale (en réintégrant notamment le phasage décrit dans le guide "producteurs-schemas") et dans le second que ce qui est spécifique de l'outil "schéma" (principe, mise en œuvre, gestion/suivi). Cette approche permettrait également d'ajouter au fur et à mesure des évolutions des outils, par exemple un outil "modèle de données", un outil "métadonnées", un outil "score qualité", un outil "représentation multi-fichiers"...

Déplacer la "liste des algorithmes publiés" du guide des algorithmes publics vers celui des codes sources

Le guide des algorithmes publics contient une liste tenue à jour par @bzg sur les algorithmes publiés (CNAF, calculateur du code des impôts, etc.).

Je crains que la localisation de cette page à cet endroit là (dans le guide des algorithmes) contribue à entretenir une certaine confusion dans l'esprit de nos publics qui ont déjà parfois tendance à mélanger les différentes obligations issues de la Loi pour une République numérique.

Ce guide traite des obligations de transparence des algorithmes, qui est un principe distinct (et tout à fait complémentaire) de celui de publication des codes-sources. Dans un cas on doit fournir des informations aux personnes concernées (droit à l'explication du fonctionnement et des résultats d'un algorithme), dans l'autre on doit publier un code-source.

Je propose deux choses:

  • que l'on déplace cette liste dans le guide des codes-sources (ou à tout le moins qu'elle ne figure plus à l'endroit où elle est actuellement),
  • qu'on rajoute clairement et explicitement dans le guide des algorithmes publics que d'autres ressources sont disponibles, dont le guide sur la publication des codes sources

Ajouter explications sur les séparateurs et Table Schema

(J'ai hésité sur le lieu pour avoir cette discussion, au final ici me paraît le plus adapté. En effet, les guides Etalab ont vocation à mon avis à faire référence en la matière et s'appliquer de façon canonique aux différents projets et produits *.data.gouv.fr)

Les séparateurs dans les fichiers tabulaires sont un sujet de désaccords récurrent. Pourtant, pour les producteurs de données, les séparateurs ne devraient avoir aucune espèce d'importance. Par exemple, l'utilisation des schémas Table Schema permet justement de supprimer certaines de ces préoccupations qui sont autant de frictions à l'ouverture des données.

La conversation qui a lieu depuis le 28 avril sur la page de la Base nationale consolidée des lieux de covoiturage illustre bien les différents problèmes.

Premièrement, il y a à la base l'éternel débat du point-virgule contre la virgule et la croyance qu'il y aurait un "standard CSV" à respecter. Il serait possible sur ce point de compléter le guide d'Etalab afin de casser les idées reçues sur le CSV. Les utilisateurs pourraient ainsi s'y référer.

Deuxièmement, le plus important pour moi serait d'expliquer que les séparateurs n'ont la plupart du temps pas d'importance. En particulier, documenter le fait que la spécification Table Schema n’a aucune notion de séparateur puisqu'on travaille sur des données tabulaires et pas que des CSV. En clair, un fichier sera valide s'il respecte le schéma, quel que soit le séparateur utilisé et même quel que soit son format tant qu'il est supporté (.csv, .xlsx, .xls, .ods...).

La documentation du SCDL, avec ses "recommandations pour le formatage des fichiers" rédigées par OpenDataFrance, entretient également cette confusion. Nous allons tâcher d'y remédier : https://git.opendatafrance.net/scdl/documentation/-/issues/12, mais je pense que ça sera plus facile de convaincre OpenDataFrance si Etalab montre la voie.

Enfin, il faudrait enlever toutes les mentions de séparateurs dans la documentation des schémas, en l'occurence celle du schéma des lieux de covoiturage. Pour clarifier encore davantage, il faudrait préciser que les producteurs peuvent choisir le séparateur (et le format tabulaire) qu'ils préférent.

Qu'en pensez-vous ? @geoffreyaldebert @abulte @fchabouis

Changer d'hébergeur

Vercel (Zeit) a changé de modèle et il n'y a plus de plan gratuit pour les organisations (cf mail ci-dessous). Ils n'ont pas encore menacé de couper mais ça pourrait arriver rapidement.

Je vois deux solutions :

  • GitHub pages
  • dokku

Your Vercel team, Etalab, is on a "free" plan, which makes you an early adopter!

Companies often cut features to force upgrades from their early adopters, but we'd rather entice upgrades through better features and performance (and a steep discount)! After all, we appreciate early adopters and can afford to help non-commercial projects ship through us.

So, if your company might benefit from an Enterprise plan, now is the time to discuss! Vercel Enterprise plans get the full benefit of our Edge Network, advanced security, and priority support (including Next.js support).

Again, we will steeply discount the price in for upgrades made in June/July so you can experience Vercel the way it was meant to be!

Let me know - cheers!

Changement config.js

Je m'entraine à faire évoluer config.js du VuePress avec l'ajout du guide datagouv. Une fois que les md de datagouv seront à la racine de datagouv, est-ce que ca ressemblerait à ca ?

sidebar = {
'/qualite/': [
'',
'0-introduction',
'1-preparer-le-jeu-de-donnees',
'2-documenter-les-donnees',
'3-elements-organisationnels',
],
'/datagouv/': [
'',
'0-introduction',
'1-creer-un-compte-utilisateur',
'2-creer-ou-rejoindre-une-organisation',
'3-publier-un-jeu-de-donnees',
'4-animer-la-communaute-de-reutilisateurs',
],
// add other guides here, like this:
// '/dummy/': [
// '',
// 'dummy-child',
// 'dummy-child-dir/dummy-child-dir-child'
// ]
}

module.exports = {
title: 'guides.etalab.gouv.fr',
description: 'Les guides d'Etalab',
themeConfig: {
sidebar: sidebar,
sidebarDepth: 1,
logo: '/images/logo-marianne.svg',
// lastUpdated: 'Dernière mise à jour',
repo: 'etalab/guides',
editLinks: true,
editLinkText: 'Proposer des modifications sur cette page'
},
locales: {'/': {lang: 'fr-FR'}},
dest: 'public',
head: [
['link', { rel: 'icon', href: '/images/favicon.png' }],
],
markdown: {
toc: { includeLevel: [2, 3, 4, 5] }
}
}

Ajout d'une licence

Il faudrait une licence sur ce dépôt à terme.

Je pense qu'il en faut 2 : une pour le peu de code et l'autre pour le contenu du guide.

D'instinct, je dirais MIT / LO.

Vous avez la même lecture ?
Comment raisonnablement bien spécifier 2 licences différentes dans un même dépôt ?

Retours utilisateurs

Hello,
Afin de récolter le plus de retours possibles sur le guide, serait-il possible de proposer un form ou un module de commentaire pour les lecteurs ?
La solution de github fonctionne bien, mais elle reste une grosse barrière à l'entrée. Surtout si on garde en tête que les lecteurs des guides pourront être des agents administratifs qui n'ont pas forcément de compétences techniques ou de connaissance de github.

Dites-moi ce que vous en pensez !

Erreur de lien dans le guide "Expliquer les algorithmes publics"

Bonjour,

Je pense qu'il y a une erreur de renvoi dans le guide Expliquer les algorithmes publics

* **Les obligations liées à l'ouverture des codes sources** (voir le [guide d'Etalab sur l'ouverture des codes sources de logiciels](https://guides.etalab.gouv.fr/algorithmes/)) ;

Le lien devrait plutôt renvoyer vers https://guides.etalab.gouv.fr/logiciels/#a-qui-s-adresse-ce-guide

poke @pedevineau @KimMontalibet

J'ai pas fait la PR, j'attends votre validation.

Problème avec le build Vercel

Lors de ma PR, #192, j'ai eu cette erreur lors du build https://vercel.com/etlb/guides.etalab.gouv.fr/Bhxt8HKsvqvBrTVTSBjTc7TCnwSn qui m'indique que la version de Node utilisée n'est plus supportée lors du build Vercel https://vercel.com/docs/concepts/functions/serverless-functions/runtimes/node-js#node.js-version

Je suis passé en choisissant dans package.json "engines": { "node": ">12 <=18" } mais cela m'a planté (https://vercel.com/etlb/guides.etalab.gouv.fr/4ZUMgKB13NBG66roSUZ2FK63zRWX#L55-L70) du fait de vercel/next.js#30296

La solution court terme à part faire une MAJ webpack est de passer par le choix de "engines": {"node": ">12 <17"}? C'est ce que j'ai fait dans ma PR. Je ne sais pas s'il y a une façon plus élégante de faire, sachant que je n'ai pas la main sur l'environnement d'exécution de Vercel pour par exemple jouer sur NODE_OPTIONS qui peut jouer sur le bon fonctionnement du build selon les remontées liées au bug webpack mentionné

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.