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.

Sign up for GitHub

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

Jump to bottom

Squelette de la documentation #3

Open
ColinMaudry opened this issue May 5, 2020 · 8 comments
Open

Squelette de la documentation #3

ColinMaudry opened this issue May 5, 2020 · 8 comments
Assignees
@ColinMaudry

Comments

@ColinMaudry
Copy link
Contributor

Créer la structure de la documentation.
@ColinMaudry ColinMaudry self-assigned this May 5, 2020
@ColinMaudry
Copy link
Contributor Author

Je pense à cette structure pour la doc. Des commentaires @strainel ?

  • Contexte
    • évolutions à venir
      • Arrêté avis de publicité en vigueur en 2022
      • Convergence recensement-DECP en 2023
  • Données publiées
    • Où ?
      • data.economie.gouv.fr
      • data.gouv.fr
    • Quoi ?
      • sources (et sources manquantes identifiées)
      • contenu
      • stats
    • Schémas
      • versions
  • Traitements des données
    • dépôt(s) de code
    • collecte
    • corrections
    • consolidation
    • publication

@strainel
Copy link

strainel commented May 5, 2020

oui c'est l'idée. j'organiserai plutôt ainsi. @ColinMaudry @arnaud-famin

  • Contexte et présentation générale

    • Objectifs
    • Textes législatifs et réglementaires
    • Acteurs / partenaires

  • DECP

    • Données publiées
      • Où les trouver ? (données consolidées et données "augmentées")
      • Monitoring & tableau de bord orienté métiers
      • Les schémas
    • Processus de consolidation
      • Collecte / Corrections / Consolidation / Publication
      • Enrichissement des données

  • Contribution ouverte

    • Ateliers
    • Dépôts GitHub
    • Prochaines évolutions
    • Signalement d'anomalies

@ColinMaudry
Copy link
Contributor Author

ColinMaudry commented May 5, 2020 •
edited
Loading

Un des enjeux est de répartir l'information entre cette documentation centralisée et la documentation présente dans les datasets et les dépôts de code.

Je vais trouver un équilibre entre :

  • dupliquer une partie de l'information pour faire la jonction et ne pas forcer la visite de chaque dataset et chaque dépôt (= decp-docs doit être un minimum "standalone")
  • ne dupliquer que de l'information intemporelle, de façon à ne pas devoir la mettre à jour à X endroits différents (decp-docs + dataset/repo de code)

ColinMaudry added a commit to ColinMaudry/decp-docs that referenced this issue May 5, 2020
@ColinMaudry
Contexte, données 139bercy#3
6af1bca
@ColinMaudry ColinMaudry mentioned this issue May 5, 2020
Merged
@strainel
Copy link

strainel commented May 5, 2020

Je ne suis pas sûr ; il n'y a pas d'enjeu à laisser éparpiller la documentation. Il faut éviter le labyrinthe documentaire et renvoyer systématiquement vers un lieu unique de document en utilisant par exemple des liens fins vers les parties documentaires concernés.

@ColinMaudry
Copy link
Contributor Author

Donc on réduit le README des dépôts de code au minimum (dépendances, installation, exécution) ?

On pourrait aussi les importer automatiquement dans la doc centrale, le lien est prévisible (https://raw.githubusercontent.com/139bercy/repo/master/README.md). Mais plus tard, ça tient pas dans le temps prévu (de mon côté du moins).

@ColinMaudry
Copy link
Contributor Author

Par exemple, les données contenues dans les DECP sont détaillées sur le dataset Référentiel de données marchés publics.

Si je te suis, je supprime cette information du dataset et je l'inclus dans la doc ?

@strainel
Copy link

strainel commented May 6, 2020

Sur cet exemple précis : il s'agit du format du fichier. Il me parait utile qu'il soit correctement documenté et rassemblé sur le nouvel espace documentaire DECP. À terme, la page du dataset doit renvoyer vers les bons éléments de la documentation.

@ColinMaudry
Copy link
Contributor Author

ColinMaudry commented May 6, 2020 •
edited
Loading

Actuellement pas d'enrichissement des données, mais on garde l'idée sous le coude (à partir du SIRENE par exemple).

ColinMaudry added a commit to ColinMaudry/decp-docs that referenced this issue May 6, 2020
@ColinMaudry
Information sur les schémas et application des correction 139bercy#3
24f5b48
ColinMaudry added a commit to ColinMaudry/decp-docs that referenced this issue May 6, 2020
@ColinMaudry
Détails des traitements 139bercy#3
42a99e3
ColinMaudry added a commit to ColinMaudry/decp-docs that referenced this issue May 12, 2020
@ColinMaudry
Mise en liste pour la lisibilité 139bercy#3
1806b43
ColinMaudry added a commit to ColinMaudry/decp-docs that referenced this issue May 12, 2020
@ColinMaudry
Ajouts de TODO pour compléter le contenu à l'avenir 139bercy#3
e2128f9
strainel added a commit that referenced this issue May 13, 2020
@ColinMaudry @strainel
WIP - Documentation initiale (#4)
7658daa 
* Remplacement de Ace (imbuvable) par un thème temporaire plus simple, hugo-primer #1

* Contexte, données #3

* Màj du README pour tenir compte du changement de thème provisoire

* Update content/contexte/_index.md

Co-authored-by: Stéphane Trainel <[email protected]>

* Update content/donnees.md

Co-authored-by: Stéphane Trainel <[email protected]>

* Information sur les schémas et application des correction #3

* Détails des traitements #3

* Mise en liste pour la lisibilité #3

* Ajouts de TODO pour compléter le contenu à l'avenir #3

Co-authored-by: Stéphane Trainel <[email protected]>
strainel added a commit that referenced this issue Jun 12, 2020
@ColinMaudry @strainel
Thème Ace (#7)
541cb6e 
* Remplacement de Ace (imbuvable) par un thème temporaire plus simple, hugo-primer #1

* Contexte, données #3

* Màj du README pour tenir compte du changement de thème provisoire

* Update content/contexte/_index.md

Co-authored-by: Stéphane Trainel <[email protected]>

* Update content/donnees.md

Co-authored-by: Stéphane Trainel <[email protected]>

* Information sur les schémas et application des correction #3

* Détails des traitements #3

* Mise en liste pour la lisibilité #3

* Ajouts de TODO pour compléter le contenu à l'avenir #3

* URLs : etalab => 139bercy

* Ajout des objectifs du projet

* Ajout des liens vers les schémas

* Import du contenu publier dans la doc data.gouv.fr #5

* Retenu du contenu lié à la publication des données #5

* Amélioration du chapitre sur la publication des données closed #5

* Ajout des instructions pour déclarer un profil d'acheteur

* Données et schémas, plutôt que juste Données

* Installation de Ace comme gitmodule

* Mise à jour de la doc

* Coquille

Co-authored-by: Stéphane Trainel <[email protected]>

* Update content/contexte/_index.md

Co-authored-by: Stéphane Trainel <[email protected]>

* Coquille

Co-authored-by: Stéphane Trainel <[email protected]>

Co-authored-by: Stéphane Trainel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ColinMaudry ColinMaudry

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ColinMaudry @strainel