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

feat(courrier-types): remove manual script step on docs update #1699

Merged
merged 1 commit into from
Nov 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions packages/code-du-travail-data/dataset/courrier-type/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Indexation des courrier type

Afin de pouvoir proposer à l'utilisateur des courriers type en fonction de sa recherche,
Il faut pouvoir indexer les differents courriers disponibles.
Il faut pouvoir indexer les differents courriers disponibles.

Les courriers sont stockés dans le dossier `/dataset/courrier-type/docx`. Afin de pouvoir qualifier chaque courrier, un fichier json (`/dataset/courrier-type/courriers.json`) permet de faire le lien entre un fichier de courrier type et ses métadonnées.
Les courriers sont stockés dans le dossier [`./docx`](./docx). Afin de pouvoir qualifier chaque courrier, un fichier json [`./courriers.json`](./courriers.json) permet de faire le lien entre un fichier de courrier type et ses métadonnées.

Pour générer le fichier qui servira à l'indexation, la commande
```
$ npm start
```
va générer le fichier `/dataset/export-courriers.json` qui sera ensuite indexé par ElasticSearch.
Un fichier `export-courriers.json` contenant une version HTML des modèles et leur metadonnées est créé avant l'indexation dans Elastic.

**Important**: Le contenu des fichiers n'est pas indéxé. Seules les metadonnées présentes dans le fichier `/dataset/courriers-type/courriers.json` sont utilisées.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"doc": "docs"
},
"scripts": {
"start": "node index > ../export-courriers.json"
"start": "node index > ./export-courriers.json"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

},
"author": "Lionel Breduillieard <[email protected]>",
"license": "ISC",
Expand Down
Loading