Skip to content

Commit

Permalink
Update README to mention JSON publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
hjonin committed Jan 30, 2024
1 parent 3da0c6e commit fadae49
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
8 changes: 3 additions & 5 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ Ces critères leur confère un caractère **fortement réutilisable** par toute
Ces projets forment un sous-ensemble de tous ceux que l'on trouve sur
[code.gouv.fr/public](https://code.gouv.fr/public/) et ils sont
publiés sur cette page dédiée :
[code.gouv.fr/fr/awesome](https://code.gouv.fr/fr/awesome/)
[code.gouv.fr/fr/awesome](https://code.gouv.fr/fr/awesome/).

Ils sont décrits dans les fichiers `*.publiccode.yml` du répertoire
[/dist](/dist/). Le format de ce fichier est détaillé dans la [documentation du format](schema.md).

Ils sont également publiés au format JSON : [code.gouv.fr/data/awesome-codegouvfr.json](https://code.gouv.fr/data/awesome-codegouvfr.json).

Un exemple de description d'un projet se trouve dans le fichier
[template.publiccode.yml](template.publiccode.yml).

Expand Down Expand Up @@ -60,10 +62,6 @@ Vous pouvez utiliser le [`template.publiccode.yml`](template.publiccode.yml) com

Vous pouvez également soumettre une Pull Request contenant le fichier `*.publiccode.yml` de votre projet. Pour le créer, vous pouvez copier le [`template.publiccode.yml`](template.publiccode.yml), ou en générer un à partir de [la petite API d'outillage dédiée](https://github.com/codegouvfr/awesome-codegouvfr-tooling), et le modifier/compléter.

# Comment mettre à jour la page [code.gouv.fr/fr/awesome](https://code.gouv.fr/fr/awesome) ?

Ce dépôt est utilisé comme un sous-module du [dépôt du site](https://github.com/codegouvfr/codegouvfr-website). Il faut mettre à jour le sous-module dans ce dépôt (`git pull && git commit`).

# Licence

Les données de ce dépôt sont publiées sous licence Ouverte [Etalab
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ These criteria make them **strongly reusable** by any administration.

These projects are a subset of all the projects found on
[code.gouv.fr/public](https://code.gouv.fr/public/) and they can be found on this dedicated page:
[code.gouv.fr/en/awesome](https://code.gouv.fr/fr/awesome/)
[code.gouv.fr/en/awesome](https://code.gouv.fr/fr/awesome/) and via the `json` file: [code.gouv.fr/data/awesome-codegouvfr.json](https://code.gouv.fr/data/awesome-codegouvfr.json).

They are described in the `*.publiccode.yml` files in the
[/dist](/dist/) directory. The format of this file is detailed in the [schema documentation](schema.md).

They are also published in JSON format: [code.gouv.fr/data/awesome-codegouvfr.json](https://code.gouv.fr/data/awesome-codegouvfr.json).

An example of a project description can be found in the file
[template.publiccode.yml](template.publiccode.yml).

Expand Down Expand Up @@ -58,10 +60,6 @@ You can use the [`template.publiccode.yml`](template.publiccode.yml) as an examp

You can also submit a pull request containing the `*.publiccode.yml` file for your project. To create it, you can copy the [`template.publiccode.yml`](template.publiccode.yml), or generate one from [the small dedicated tooling API](https://github.com/codegouvfr/awesome-codegouvfr-tooling), and modify/complete it.

# How do I update the [code.gouv.fr/fr/awesome](https://code.gouv.fr/fr/awesome) page?

This repository is used as a submodule of the [website repository](https://github.com/codegouvfr/codegouvfr-website). You need to update the submodule in this repository (`git pull && git commit`).

# Licence

The data in this repository is published under the [Etalab
Expand Down

0 comments on commit fadae49

Please sign in to comment.