From bd49d94244ab34aeabbb6e073e10285e4bf77d12 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Thu, 30 Nov 2023 16:34:01 +0100 Subject: [PATCH 01/22] init PR From f9e00493712b59acc8723f7c7e7afb7983416774 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Thu, 30 Nov 2023 16:38:27 +0100 Subject: [PATCH 02/22] interface en-fr: try to fix errors in workingVersion.jsx and Versions.jsx - translation by/par --- front/src/components/Write/Versions.jsx | 2 +- front/src/components/Write/WorkingVersion.jsx | 2 +- front/src/locales/en/translation.json | 5 +++-- front/src/locales/fr/translation.json | 5 +++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/front/src/components/Write/Versions.jsx b/front/src/components/Write/Versions.jsx index f2a54e3eb..cae230073 100644 --- a/front/src/components/Write/Versions.jsx +++ b/front/src/components/Write/Versions.jsx @@ -84,7 +84,7 @@ function Version ({ articleId, compareTo, readOnly, selectedVersion, v }) { {!renaming &&

{v.owner && ( - by {v.owner.displayName || v.owner.username} + {t('article.by.text', {owner: v.owner.displayName || v.owner.username})} )} diff --git a/front/src/components/Write/WorkingVersion.jsx b/front/src/components/Write/WorkingVersion.jsx index a58c160ad..917d29eea 100644 --- a/front/src/components/Write/WorkingVersion.jsx +++ b/front/src/components/Write/WorkingVersion.jsx @@ -133,7 +133,7 @@ export default function WorkingVersion ({ articleInfos, live, selectedVersion, m

    -
  • by {articleOwnerAndContributors.join(', ')}
    • +
  • {t('workingVersion.by.text')} {articleOwnerAndContributors.join(', ')}
    • diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index f812173c5..80b22f96d 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by", + "article.by.text": "by {{owner}}", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", @@ -177,5 +177,6 @@ "workingVersion.stateUiProps.savedText": "Last saved", "workingVersion.stateUiProps.savingText": "Saving", "workingVersion.stateUiProps.saveErrorText": "Error", - "workingVersion.spanWorkingCopy.text": "working copy" + "workingVersion.spanWorkingCopy.text": "working copy", + "workingVersion.by.text": "by" } diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 2338cbf7d..276d03881 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par", + "article.by.text": "par {{owner}}", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", @@ -175,5 +175,6 @@ "workingVersion.stateUiProps.savedText": "Dernière sauvegarde", "workingVersion.stateUiProps.savingText": "En cours de sauvegarde", "workingVersion.stateUiProps.saveErrorText": "Erreur", - "workingVersion.spanWorkingCopy.text": "version de travail" + "workingVersion.spanWorkingCopy.text": "version de travail", + "workingVersion.by.text": "par" } From 234f405d3b7233de77fc3130e1fb7b7ed1ab9779 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Thu, 30 Nov 2023 20:31:52 +0100 Subject: [PATCH 03/22] interface en-fr: test suppression de la variable {{owner}} dans la clef article.by.text --- front/src/components/Write/Versions.jsx | 2 +- front/src/locales/en/translation.json | 2 +- front/src/locales/fr/translation.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/front/src/components/Write/Versions.jsx b/front/src/components/Write/Versions.jsx index cae230073..d115dca40 100644 --- a/front/src/components/Write/Versions.jsx +++ b/front/src/components/Write/Versions.jsx @@ -84,7 +84,7 @@ function Version ({ articleId, compareTo, readOnly, selectedVersion, v }) { {!renaming &&

    {v.owner && ( - {t('article.by.text', {owner: v.owner.displayName || v.owner.username})} + {t('article.by.text')} )} diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index 80b22f96d..08f9a4400 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by {{owner}}", + "article.by.text": "by", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 276d03881..5ed0b76e5 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par {{owner}}", + "article.by.text": "par", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", From 05cda5a7ae6856d086ddf440d2b14aa271a58ad5 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Fri, 8 Mar 2024 20:28:37 +0100 Subject: [PATCH 04/22] =?UTF-8?q?ajout=20de=20la=20variable=20{{owner}}=20?= =?UTF-8?q?dans=20le=20texte=20associ=C3=A9=20aux=20versions=20d'un=20arti?= =?UTF-8?q?cle?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- front/src/components/Write/Versions.jsx | 2 +- front/src/locales/en/translation.json | 2 +- front/src/locales/fr/translation.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/front/src/components/Write/Versions.jsx b/front/src/components/Write/Versions.jsx index d115dca40..cae230073 100644 --- a/front/src/components/Write/Versions.jsx +++ b/front/src/components/Write/Versions.jsx @@ -84,7 +84,7 @@ function Version ({ articleId, compareTo, readOnly, selectedVersion, v }) { {!renaming &&

    {v.owner && ( - {t('article.by.text')} + {t('article.by.text', {owner: v.owner.displayName || v.owner.username})} )} diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index 08f9a4400..80b22f96d 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by", + "article.by.text": "by {{owner}}", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 5ed0b76e5..276d03881 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par", + "article.by.text": "par {{owner}}", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", From b4107d3cf3776a2bf17df4a631ac8f8f27690114 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Sat, 9 Mar 2024 10:42:30 +0100 Subject: [PATCH 05/22] test ajout des balises dans le json des traductions --- front/src/locales/en/translation.json | 2 +- front/src/locales/fr/translation.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index 80b22f96d..d3dc32c02 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by {{owner}}", + "article.by.text": "by {{owner}}", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 276d03881..2a29529ba 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par {{owner}}", + "article.by.text": "par {{owner}}", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", From 3dd0aa2a94d2e268428f7d5bd467f5b95345ccef Mon Sep 17 00:00:00 2001 From: RochDLY Date: Sat, 9 Mar 2024 10:45:18 +0100 Subject: [PATCH 06/22] suppression de la balise strong dans le json des traductions --- front/src/locales/en/translation.json | 2 +- front/src/locales/fr/translation.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index d3dc32c02..80b22f96d 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by {{owner}}", + "article.by.text": "by {{owner}}", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 2a29529ba..276d03881 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par {{owner}}", + "article.by.text": "par {{owner}}", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", From f5324b82992e1d8c420b74e90884beb297045944 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Mon, 11 Mar 2024 09:00:25 +0100 Subject: [PATCH 07/22] =?UTF-8?q?traduction=20en-fr=20:=E2=80=AFajout=20d'?= =?UTF-8?q?une=20clef=20pour=20le=20terme=20by=20dans=20les=20versions=20a?= =?UTF-8?q?ffich=C3=A9es=20dans=20les=20m=C3=A9tadonn=C3=A9es=20de=20l'art?= =?UTF-8?q?icle?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- front/src/components/Write/Versions.jsx | 2 +- front/src/locales/en/translation.json | 3 ++- front/src/locales/fr/translation.json | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/front/src/components/Write/Versions.jsx b/front/src/components/Write/Versions.jsx index cae230073..0d9092053 100644 --- a/front/src/components/Write/Versions.jsx +++ b/front/src/components/Write/Versions.jsx @@ -84,7 +84,7 @@ function Version ({ articleId, compareTo, readOnly, selectedVersion, v }) { {!renaming &&

    {v.owner && ( - {t('article.by.text', {owner: v.owner.displayName || v.owner.username})} + {t('version.by.text', {owner: v.owner.displayName || v.owner.username})} )} diff --git a/front/src/locales/en/translation.json b/front/src/locales/en/translation.json index 80b22f96d..cd86048ed 100644 --- a/front/src/locales/en/translation.json +++ b/front/src/locales/en/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Workspaces", "article.tags.title": "Tags", - "article.by.text": "by {{owner}}", + "article.by.text": "by", "article.deleteModal.title": "Delete an article", "article.deleteModal.confirmMessage": "Are you sure you want to delete this article?", "article.deleteModal.contributorsRemovalNote": "If you delete this article, contributors won't have access to this article anymore.", @@ -70,6 +70,7 @@ "article.sendCopy.errorNotification": "Unable to send a copy of the article: {{errMessage}}", "version.editingSessionEnded.text": "Editing session ended", "version.collaborativeSessionEnded.text": "Collaborative session ended", + "version.by.text": "by {{owner}}", "collaborativeSessionAction.launchCollaborativeSessionButton.title": "Collaborative editing", "soloSessionAction.launchSoloSessionButton.title": "Edit article", "modal.cancelButton.text": "Cancel", diff --git a/front/src/locales/fr/translation.json b/front/src/locales/fr/translation.json index 276d03881..5a5f08a65 100644 --- a/front/src/locales/fr/translation.json +++ b/front/src/locales/fr/translation.json @@ -48,7 +48,7 @@ "article.versions.title": "Versions", "article.workspaces.title": "Espaces de travail", "article.tags.title": "Étiquettes", - "article.by.text": "par {{owner}}", + "article.by.text": "par", "article.deleteModal.title": "Supprimer un article", "article.deleteModal.confirmMessage": "Êtes-vous sûr de vouloir supprimer cet article ?", "article.deleteModal.contributorsRemovalNote": "Si vous supprimez cet article, les contributeurs ne pourront plus accéder à celui-ci.", @@ -70,6 +70,7 @@ "article.sendCopy.errorNotification": "Impossible d'envoyer une copie de l'article: {{errMessage}}", "version.editingSessionEnded.text": "Session d'édition terminée", "version.collaborativeSessionEnded.text": "Session collaborative terminée", + "version.by.text": "par {{owner}}", "collaborativeSessionAction.launchCollaborativeSessionButton.title": "Édition collaborative", "soloSessionAction.launchSoloSessionButton.title": "Modifier l'article", "modal.cancelButton.text": "Annuler", From aa1494b2d0330d920d6366df671acec785a6b5a1 Mon Sep 17 00:00:00 2001 From: Guillaume Grossetie Date: Sun, 3 Dec 2023 02:22:45 +0000 Subject: [PATCH 08/22] Update dependency davidbgk/stylo-export to v1 --- docker-compose.yaml | 2 +- infrastructure/templates/docker-compose.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docker-compose.yaml b/docker-compose.yaml index 741cbb88e..0379c7cdc 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -72,7 +72,7 @@ services: - graphql-stylo export-gateway: - image: "davidbgk/stylo-export:0.0.33" + image: "davidbgk/stylo-export:1.0.0" env_file: - stylo.env environment: diff --git a/infrastructure/templates/docker-compose.yaml b/infrastructure/templates/docker-compose.yaml index 0f99dc37a..20222e861 100644 --- a/infrastructure/templates/docker-compose.yaml +++ b/infrastructure/templates/docker-compose.yaml @@ -56,7 +56,7 @@ services: - graphql-stylo export-gateway: - image: "davidbgk/stylo-export:0.0.33" + image: "davidbgk/stylo-export:1.0.0" env_file: - stylo.env environment: From e5e4393aea74187463c01934d8e060d8a3f02b4f Mon Sep 17 00:00:00 2001 From: Guillaume Grossetie Date: Wed, 6 Dec 2023 17:24:22 +0100 Subject: [PATCH 09/22] resolves #992 purge les images Docker --- infrastructure/playbook.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/infrastructure/playbook.yml b/infrastructure/playbook.yml index 972e9a0be..a4da58d3b 100644 --- a/infrastructure/playbook.yml +++ b/infrastructure/playbook.yml @@ -66,6 +66,18 @@ when: site == "stylo.huma-num.fr" notify: reload nginx + - name: Prune Docker images + become: yes + ansible.builtin.shell: + cmd: "docker image prune -af" + run_once: true + + - name: Prune Docker system + become: yes + ansible.builtin.shell: + cmd: "docker system prune -af" + run_once: true + - name: Copy systemd service file become: yes ansible.builtin.copy: From 9d8c99405a0a2be67795d803d88e47d36b585c94 Mon Sep 17 00:00:00 2001 From: null <@users.noreply.github.com> Date: Wed, 6 Dec 2023 16:35:13 +0000 Subject: [PATCH 10/22] Release 3.0.7 --- front/package-lock.json | 4 ++-- front/package.json | 2 +- graphql/package-lock.json | 4 ++-- graphql/package.json | 2 +- package-lock.json | 4 ++-- package.json | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/front/package-lock.json b/front/package-lock.json index 2f1ebc64d..3410438b7 100644 --- a/front/package-lock.json +++ b/front/package-lock.json @@ -1,12 +1,12 @@ { "name": "@ecrituresnumerique/stylo-front", - "version": "3.0.6", + "version": "3.0.7", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@ecrituresnumerique/stylo-front", - "version": "3.0.6", + "version": "3.0.7", "license": "MIT", "dependencies": { "@babel/plugin-proposal-async-generator-functions": "^7.20.1", diff --git a/front/package.json b/front/package.json index 6432e8c2a..10468e7f1 100644 --- a/front/package.json +++ b/front/package.json @@ -2,7 +2,7 @@ "name": "@ecrituresnumerique/stylo-front", "private": true, "description": "Stylo front-end, online text editor for scholars", - "version": "3.0.6", + "version": "3.0.7", "license": "MIT", "type": "module", "#browserlist#": "https://browserslist.dev/?q=ZGVmYXVsdHMsIGxhc3QgMiB2ZXJzaW9ucywgbm90IGRlYWQsID4gMC4yJQ%3D%3D", diff --git a/graphql/package-lock.json b/graphql/package-lock.json index bf433eaf6..a23ae4256 100644 --- a/graphql/package-lock.json +++ b/graphql/package-lock.json @@ -1,12 +1,12 @@ { "name": "graphql-stylo", - "version": "3.0.6", + "version": "3.0.7", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "graphql-stylo", - "version": "3.0.6", + "version": "3.0.7", "license": "ISC", "dependencies": { "@graphql-tools/schema": "^9.0.12", diff --git a/graphql/package.json b/graphql/package.json index c97088bd6..94e5fcadc 100644 --- a/graphql/package.json +++ b/graphql/package.json @@ -1,6 +1,6 @@ { "name": "graphql-stylo", - "version": "3.0.6", + "version": "3.0.7", "description": "", "main": "index.js", "private": true, diff --git a/package-lock.json b/package-lock.json index 0b59542b9..22f50c768 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@EcrituresNumeriques/stylo", - "version": "3.0.6", + "version": "3.0.7", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@EcrituresNumeriques/stylo", - "version": "3.0.6", + "version": "3.0.7", "license": "GPL-3.0", "devDependencies": { "concurrently": "^7.6.0", diff --git a/package.json b/package.json index b93f78945..4b9b7943e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@EcrituresNumeriques/stylo", "private": true, - "version": "3.0.6", + "version": "3.0.7", "description": "Stylo est un éditeur de textes pour articles scientifiques en sciences humaines et sociales.", "main": "index.js", "directories": { From c2b6953487b10177c24869938cbd2975c297d184 Mon Sep 17 00:00:00 2001 From: Guillaume Grossetie Date: Thu, 14 Dec 2023 14:18:50 +0100 Subject: [PATCH 11/22] =?UTF-8?q?resolves=20#993=20r=C3=A9cup=C3=A8re=20la?= =?UTF-8?q?=20derni=C3=A8re=20version=20des=20articles=20d'un=20corpus?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- export/src/export.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/export/src/export.js b/export/src/export.js index 07465ffaa..e209ad3cb 100644 --- a/export/src/export.js +++ b/export/src/export.js @@ -146,7 +146,7 @@ function createBookExportContext (chapters, { id, title }) { const chaptersSorted = chapters.sort((a, b) => a.order - b.order).map((c) => c.article) const chaptersData = chaptersSorted.reduce((acc, chapter) => { const workingVersion = chapter.versions.length > 0 - ? chapter.versions[chapter.versions.length - 1] + ? chapter.versions[0] // versions ordered by creation date descending (first version is the latest version) : chapter.workingVersion acc.bib.push(workingVersion.bib) acc.md.push(workingVersion.md) From b467b231de2e8b6d1b58fa7172596dfa497d2a99 Mon Sep 17 00:00:00 2001 From: Nicolas Sauret Date: Wed, 6 Dec 2023 14:14:01 +0100 Subject: [PATCH 12/22] =?UTF-8?q?ajout=20d'une=20section=20de=20documentat?= =?UTF-8?q?ion=20=E2=86=92=20bibliographie=20cas=20particuliers?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/src/fr/bibliographie.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/src/fr/bibliographie.md b/docs/src/fr/bibliographie.md index 8602d07ab..7ab82ebd5 100644 --- a/docs/src/fr/bibliographie.md +++ b/docs/src/fr/bibliographie.md @@ -95,6 +95,32 @@ Par exemple : **Attention :** il ne faut pas utiliser de syntaxe Markdown en accompagnement d'une citation. Par exemple, il ne faut surtout pas utiliser un balisage de ce type : `[@shirky_here_2008, [lien vers une page web](https://sens-public.org)]` +## Cas particuliers + +### Lettres capitales pour les titres en anglais + +Les styles bibliographiques en anglais requièrent souvent une capitalisation de chaque mot du titre de la référence. Stylo (et Pandoc) vont correctement styler les titres à condition que les références déclarent bien la langue utilisée. + +La langue du document Stylo détermine la langue du style bibliographique par défaut pour toutes les références, sauf pour les références bibliographiques contenant une autre donnée de langue. Par exemple, si la langue déclarée dans les métadonnées du document est `fr`, les références seront traitées comme telles. Si, parmi ces références, l'une est déclarée `en`, alors la capitalisation du titre s'appliquera. + +**Attention :** le format Bibtex intègre plusieurs clés de langue : `language`, `langid`. Stylo (et Pandoc) ne prend en compte que la clé `langid`, alors que l'interface de Zotero ne permet de renseigner que la clé `language` ! Il sera donc nécessaire d'ajouter la clé `langid` directement dans le bibtex (onglet [BibTex brut] dans le gestionnaire bibliographique) pour que la langue de la référence soit correctement prise en compte par Stylo. + +```bibtex +@book{coleman_coding_2013, + address = {Princeton}, + title = {Coding freedom: the ethics and aesthetics of hacking}, + isbn = {978-0-691-14460-3}, + shorttitle = {Coding freedom}, + language = {eng}, + langid = {en}, + publisher = {Princeton University Press}, + author = {Coleman, E. Gabriella}, + year = {2013}, +} +``` + +- Pour en savoir plus : [documentation Pandoc | Capitalization in titles](https://pandoc.org/MANUAL.html#capitalization-in-titles) + ## Quelques ressources - [Qu'est-ce que Zotero ?](http://editorialisation.org/ediwiki/index.php?title=Zotero) From 9d6b4f2a5fb6dee3e5bf944bc4954d86c694219a Mon Sep 17 00:00:00 2001 From: Nicolas Sauret Date: Wed, 13 Dec 2023 14:26:29 +0100 Subject: [PATCH 13/22] add tips "section Extra" thanks @loup-brun ! --- docs/src/fr/bibliographie.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/src/fr/bibliographie.md b/docs/src/fr/bibliographie.md index 7ab82ebd5..069d38fd0 100644 --- a/docs/src/fr/bibliographie.md +++ b/docs/src/fr/bibliographie.md @@ -103,7 +103,10 @@ Les styles bibliographiques en anglais requièrent souvent une capitalisation de La langue du document Stylo détermine la langue du style bibliographique par défaut pour toutes les références, sauf pour les références bibliographiques contenant une autre donnée de langue. Par exemple, si la langue déclarée dans les métadonnées du document est `fr`, les références seront traitées comme telles. Si, parmi ces références, l'une est déclarée `en`, alors la capitalisation du titre s'appliquera. -**Attention :** le format Bibtex intègre plusieurs clés de langue : `language`, `langid`. Stylo (et Pandoc) ne prend en compte que la clé `langid`, alors que l'interface de Zotero ne permet de renseigner que la clé `language` ! Il sera donc nécessaire d'ajouter la clé `langid` directement dans le bibtex (onglet [BibTex brut] dans le gestionnaire bibliographique) pour que la langue de la référence soit correctement prise en compte par Stylo. +**Attention :** le format Bibtex intègre plusieurs propriétés de langue : `language`, `langid`. Stylo (et Pandoc) ne prend en compte que la propriété `langid`, alors que l'interface de Zotero ne permet de renseigner que la propriété `language` ! Il sera donc nécessaire d'ajouter manuellement la propriété `langid: en`. Pour cela, deux possibilités : + +1. Soit dans Zotero, utiliser [la section Extra](https://www.zotero.org/support/kb/item_types_and_fields#citing_fields_from_extra) qui permet de renseigner des couples `propriété: valeur` supplémentaire, par exemple dans notre cas : `langid: en`. Après synchronisation Zotero/Stylo, la propriété sera bien prise en compte dans Stylo. +2. Soit dans Stylo, ouvrir l'onglet [Bibtex brut] dans le gestionnaire de bibliographie, et ajouter le couple `langid: en` à la référence concernée. ```bibtex @book{coleman_coding_2013, @@ -119,6 +122,8 @@ La langue du document Stylo détermine la langue du style bibliographique par d } ``` +Notez que la synchronisation Zotero ne fonctionne que dans un sens : les ajouts ou les modifications des références dans l'onglet [Bibtex brut] ne seront pas reportés dans votre collection Zotero. Une nouvelle synchronisation depuis Zotero vers Stylo effacera vos modifications manuelles dans [Bibtex brut]. La première option (section Extra) est donc conseillée. + - Pour en savoir plus : [documentation Pandoc | Capitalization in titles](https://pandoc.org/MANUAL.html#capitalization-in-titles) ## Quelques ressources From 12609132358c7265c6c74e9cc8d05acbcb7bea18 Mon Sep 17 00:00:00 2001 From: Camille Date: Wed, 24 Jan 2024 18:59:53 -0500 Subject: [PATCH 14/22] GraphQL introduction EN/FR --- docs/src/en/api-graphql.md | 142 +++++++++++++++++++++++++++++++------ docs/src/fr/api-graphql.md | 135 ++++++++++++++++++++++++++++++----- 2 files changed, 239 insertions(+), 38 deletions(-) diff --git a/docs/src/en/api-graphql.md b/docs/src/en/api-graphql.md index 6fb22bd45..b907423b1 100644 --- a/docs/src/en/api-graphql.md +++ b/docs/src/en/api-graphql.md @@ -2,40 +2,142 @@ title: "API GraphQL" --- -## Setting up your GraphQl query +## Stylo's GraphQL API - An introduction -Stylo now incorporates a GraphQL API that users can read and write to. +Stylo now incorporates a GraphQL API to which users can read and write. The API provides access to Stylo data via the GraphQL query language. From the endpoint [https://stylo.huma-num.fr/graphql](https://stylo.huma-num.fr/graphql), you can connect Stylo to a whole range of customized functionalities. For example, the API allows you to retrieve your articles and integrate them into your favorite static site generator. -To execute a request, you must first retrieve your *APIkeys* from your Stylo account settings. -Your user account settings can be found in the drop-down menu that appears when you click on your username at the top of the interface. +GraphQL stands for **Graph Query Language**. It's a query language and runtime environment for application programming interfaces (APIs). It was first created by Facebook in 2012, and released as open source in 2015. You get only the data you need from your queries, and you define their structure. -The user key for API configuration can be found in the second section of the account parameters under the entry `API Key`. -A button allows you to copy the entire key to the clipboard. +### Why use GraphQL? -Then you can write your query in your preferred environment (e.g. [GraphQL Playground](https://github.com/graphql/graphql-playground)) and start playing with your Stylo data. -If you're using GraphQL Playground, the API self-documents directly in your interface. -You'll have access to all the queries and parameters you can use in just a few clicks. +- This environment is very easy to use. +- It lets you visualize and manipulate your data in Stylo. +- You get exactly what you ask for, and no more. You can have several types of data in a single request. +- And it's fast. +- You don't need to know how to code to use this environment, as the available requests are listed in the documentation. -Here's an example of a query to retrieve all your items: +### Before you start -```graphql -query tousMesArticles { - user { - _id - email - - articles { +1. Install GraphQL + +If you're using Google Chrome, it's easy to install the extension. You can choose, for example, GraphQL Playground or Altair GraphQL. If you want to install it on your computer and you have brew, you can also enter the command "brew cask install graphql-playground". There are a number of options available to you, and if these don't suit you, you can search for others - these are just a few suggestions. + +For this course, we'll be using the GraphQL Playground extension, but you can also use the local version or the [web version](https://legacy.graphqlbin.com/new). + +2. Enter the URL + +Once you've installed the extension or environment, make sure you enter the URL in the field provided above, i.e. https://stylo.huma-num.fr/graphql. This is the API endpoint. + +3. API key + +You also need to enter your API key. In the Stylo application, click on your name, the drop-down menu will open and then you click on your e-mail address. This will take you to your account information. This is where you'll find your key. Copy it. Back in GraphQL, on the bottom left is the "HTTP HEADERS" tab. Enter the key as follows: + +``` +{ +"Authorization": "YOUR API KEY" +} +``` + +Make sure you are in the "HTTP HEADERS" tab. + +![Getting started with GraphQL](https://upload.wikimedia.org/wikipedia/commons/2/22/Capture_d%E2%80%99%C3%A9cran_2024-01-23_181249.png) + +Now you're ready to enter your first query! + +## Getting started + +In this introduction to Stylo's GraphQL API, we'll look at how to use queries and mutations. Queries let you visualize the data available in Stylo, while mutations let you manipulate, create or delete data. + +### Queries + +Simply request a query. This is the first word in your request. +In the first example, we're asking for a list of all your articles contained in Stylo. In square brackets, we specify what other information we'd like to have. In this case, we'd like to know the associated user, the title of the article and its identifier. + +You can, of course, request other information as well. The possibilities are immense, and they go hand in hand with your needs. +Don't forget to close the brackets after opening each one.When you're ready, click the execute button. + +``` +Example 1: +query allMyArticles { + user { + _id + email + + articles { _id title + } + } +} +``` + +In example 2, you need to enter the identifier of one of the articles in the previous list. Keep it, as you'll need it for the last example too. Once you've entered the query, you should see the title of your item, as well as the person who owns it. + +``` +Example 2: +query articles { + article(article: "ARTICLE ID"){ + title + owner { + displayName + username + email } - } } +} +``` + +For this last example, once again you need to enter your article ID in the appropriate space. This time, GraphQL shows you not only the title of your article and the contributors, but also the Markdown, Yaml and BibTex it contains! + ``` +Example 3 : +query { + article(article: "ARTICLE ID"){ + title + contributors{user{displayName}} + workingVersion{md yaml bib} + } +} + +``` + +You may have noticed that the application offers you autocompletion options as you write. This gives you examples of what you can ask for later. + +You'll also find a complete list in the tab to the left of the screen called "Schema" . If you click on it, the tab opens. +The API documentation tab is one of GraphQL Playground's most interesting features. It lets you preview all possible queries and mutations, along with their details in a single field of a given schema. + +![Schema](https://upload.wikimedia.org/wikipedia/commons/c/c6/Capture_d%E2%80%99%C3%A9cran_2024-01-23_184801.png) + + +### Mutations + +In addition to queries, you can also use mutations in the interface. +What are mutations? Mutations are another form of query. However, all operations that cause writes must be sent explicitly via a mutation. Put simply, while queries allow you to view your data, mutations are used to create, modify or delete data or content. + +Let's take a look at the list in the "Schema" tab: ![Mutations](https://upload.wikimedia.org/wikipedia/commons/4/48/Capture_d%E2%80%99%C3%A9cran_2024-01-23_191722.png) + +You can create articles, share your articles, duplicate them and much more. The list goes on and on. + +Let's look at an example of a mutation: + + +``` +mutation{createArticle(title: "ARTICLE TITLE", + user:" YOUR ID ") + {title _id}} + +``` + +In this example, we're asking the API to create an article for us. To do this, enter your ID number, which you'll find either in your Stylo account information or which you can request in GraphQL Playground. Then enter the title you want in the appropriate space. Once the mutation has been launched, return to Stylo's "Articles" page and you'll see your new article with the chosen title. + +## Finally + +GraphQL Playground is like a sandbox, an integrated development environment (IDE) where you can create scripts in any language. These scripts integrate GraphQL queries to automate certain tasks: for example, we could imagine a local backup of Stylo data! -## Examples and applications +As you can see, Stylo's GraphQL API is easy to use. All you have to do is enter the name of the data you want, or the mutations you want, and the application gives them to you. That's all there is to it, and all that's left is for you to try out different queries and mutations for yourself! -Coming soon. \ No newline at end of file +More advanced training to come... \ No newline at end of file diff --git a/docs/src/fr/api-graphql.md b/docs/src/fr/api-graphql.md index ceabff89e..df813eb04 100644 --- a/docs/src/fr/api-graphql.md +++ b/docs/src/fr/api-graphql.md @@ -2,7 +2,7 @@ title: API GraphQL --- -## Configurer sa requête GraphQL +## API GraphQL de Stylo - Une introduction Stylo intègre dorénavant une API GraphQL à laquelle les utilisateurs peuvent avoir accès en lecture et en écriture. @@ -10,33 +10,132 @@ L'API donne accès aux données de Stylo grâce au langage de requête GraphQL. Depuis l'*endpoint* [https://stylo.huma-num.fr/graphql](https://stylo.huma-num.fr/graphql), il devient possible de connecter Stylo à tout un ensemble de fonctionnalités réalisées par vos soins, donc sur mesure. Par exemple, l'API vous permet de récupérer vos articles et de les intégrer dans votre générateur de site statique préféré. -Pour exécuter une requête, vous devez tout d'abord récupérer votre *APIkeys* dans les paramètres de votre compte Stylo. -Les paramètres de votre compte utilisateur se trouvent dans le menu déroulant qui apparaît lorsque vous cliquez sur votre nom d'utilisateur en haut de l'interface. +GraphQL signifie **Graph Query Language**. C'est un langage de requête et un environnement d'exécution pour les interfaces de programmation d'application (API). C'est tout d'abord une création de Facebook en 2012, qui fut publié en libre accès en 2015. Vous obtenez de vos requêtes uniquement les données demandées et vous en définissez la structure. +### Pourquoi utiliser GraphQL? -La clef utilisateur pour la configuration de l'API se trouve dans la deuxième section des paramètres du compte sous l'entrée `API Key`. -Un bouton permet de copier l'intégralité de la clef dans le presse-papier. +- Cet environnement est très simple d'utilisation. +- Elle vous permet de visualiser et de manipuler vos données contenues dans Stylo. +- Vous obtenez exactement ce que vous demandez et pas plus. Vous pouvez ainsi avoir plusieurs types de données dans une seule demande. +- C'est rapide. +- L'environnement ne requiert pas de savoir coder, les demandes disponibles sont présentes dans la documentation. -Ensuite, vous pouvez écrire votre requête dans votre environnement préféré (ex: [GraphQL Playground](https://github.com/graphql/graphql-playground)) et commencer à jouer avec vos données Stylo. -Si vous utilisez GraphQL Playground, l'API s'auto-documente directement dans votre interface. -Vous accéderez à l'ensemble des requêtes et paramètres utilisables en seulement quelques clics. +### Avant de commencer -Voici un exemple de requête pour récupérer tous vos articles : +1. Installer GraphQL -```graphql +Si vous utilisez Google Chrome, il est facile d'installer l'extension. Vous pouvez choisir par exemple GraphQL Playground ou encore Altair GraphQL. Si vous voulez l'installer sur votre ordinateur et que vous avez brew, vous pouvez aussi entrer la commande « brew cask install graphql-playground ». Plusieurs options s'offrent à vous, si celles-ci ne vous conviennent pas vous pouvez en rechercher d'autres, ce ne sont que quelques suggestions. Pour cette formation, nous allons utiliser l'extension GraphQL Playground, mais vous pouvez aussi utiliser la version locale ou la [version web](https://legacy.graphqlbin.com/new). + +2. Entrer l'URL + +Une fois l'extension ou l'environnement installé, assurez-vous d'entrer dans le champ de l'URL, celle fournie plus haut, soit https://stylo.huma-num.fr/graphql. C'est l'endpoint de l'API. + +3. Clé API + +Il vous faut aussi entrer votre clé API. Dans l'application Stylo, cliquez sur votre nom, le menu déroulant s'ouvrira et vous cliquez ensuite sur votre adresse courriel. Cela vous mènera aux informations de votre compte. C'est dans cette section que vous trouverez votre clé. Copiez-la. De retour dans GraphQL, en bas à gauche se trouve l'onglet "HTTP HEADERS". Entrez la clé comme suis : + +``` +{ +"Authorization":"VOTRE CLÉ API" +} +``` + +Assurez-vous d'être bien dans l'onglet "HTTP HEADERS". + +![Commencer avec GraphQL](https://upload.wikimedia.org/wikipedia/commons/2/22/Capture_d%E2%80%99%C3%A9cran_2024-01-23_181249.png) + +Vous êtes maintenant prêt à entrer votre première requête! + + +## Pour commencer + +Dans cette initiation à l'API GraphQL de Stylo, nous verrons comment utiliser les requêtes et les mutations. Les requêtes vous permettront de visualiser vos données disponibles dans Stylo et les mutations vous permettront de les manipuler, d'en créer ou de les supprimer. + +### Les requêtes + +Il suffit de demander une requête (Query). C'est le premier mot de votre demande. +Ensuite, il faut spécifier le type de requête, dans le premier exemple, nous lui demandons une liste de tous vos articles contenus dans Stylo. Entre crochets, nous spécifions quelles autres informations nous aimerions avoir. Dans ce cas, nous voulons savoir quel est l'utilisateur associé, le titre de l'article, ainsi que son identifiant. + +Vous pouvez bien sûr demander d'autres informations. Les possibilités sont immenses et vont de pair avec vos besoins. +Il ne faut pas oublier de refermer les crochets après l'ouverture de chacun. Quand vous êtes prêts cliquez sur le bouton d'exécution. + +``` +Exemple 1 : query tousMesArticles { - user { - _id - email - - articles { + user { + _id + email + + articles { _id title + } + } +} +``` + +Dans l'exemple 2, il vous faut entrer l'identifiant de l'un des article de la liste précédente. Gardez-le, vous en aurez aussi besoin pour le dernier exemple. Une fois la requête entrée, vous devriez voir le titre de votre article, ainsi que la personne qui le détient. + +``` +Exemple 2 : +query articles { + article(article: " ID DE L'ARTICLE "){ + title + owner { + displayName + username + email } - } } +} +``` + +Pour ce dernier exemple, il vous faut encore une fois entrer votre identifiant d'article dans l'espace approprié. Cette fois-ci, GraphQL vous montre le titre de votre article, ceux qui y ont contribué, mais aussi le Markdown, Yaml et BibTex qu'il contient! + +``` +Exemple 3 : +query { + article(article: " ID DE L'ARTICLE "){ + title + contributors{user{displayName}} + workingVersion{md yaml bib} + } +} + +``` + +Vous aurez peut-être remarqué que l'application vous offre des options d'autocomplétions lorsque vous écrivez. Cela vous donne des exemples de ce que vous pouvez demander par la suite. + +Vous trouverez aussi une liste complète dans l'onglet à gauche de l'écran « Schema ». Si vous cliquez dessus, l'onglet s'ouvre. +L'onglet de documentation de l'API est l'une des fonctionnalités les plus intéressantes de GraphQL Playground. Il vous permet de prévisualiser toutes les requêtes et mutations possibles, ainsi que leurs détails en un seul champ d'un schéma donné. + +![Schema](https://upload.wikimedia.org/wikipedia/commons/c/c6/Capture_d%E2%80%99%C3%A9cran_2024-01-23_184801.png) + + +### Les mutations + +En plus des requêtes, vous pouvez aussi utiliser des mutations dans l'interface. +Qu'est-ce que c'est? Les mutations sont une autre forme de requête. Cependant, toutes les opérations qui provoquent des écritures doivent être envoyées explicitement via une mutation. Pour faire simple, alors que les requêtes vous permettent de voir vos données, les mutations servent à créer, modifier ou supprimer des données ou du contenu. + +Regardons la liste dans l'onglet "Schema" : ![Mutations](https://upload.wikimedia.org/wikipedia/commons/4/48/Capture_d%E2%80%99%C3%A9cran_2024-01-23_191722.png) + +Vous pouvez créer des articles, partager vos articles, les dupliquer et plus encore. La liste est longue. + +Regardons un exemple de mutation : + +``` +mutation{createArticle(title:"TITRE DE L'ARTICLE", + user:" VOTRE ID ") + {title _id}} + ``` -## Exemples et applications +Dans cet exemple, nous demandons à l'API de nous créer un article. Pour ce faire entrer votre numéro d'identification que vous trouverez soit dans les informations de votre compte Stylo ou que vous pouvez demander dans GraphQL Playground. Entrez ensuite le titre que vous voulez dans l'espace approprié. Une fois la mutation lancée, retournez sur la page « Articles » de Stylo et vous verrez votre nouvel article avec le titre choisi. + +## Pour finir + +GraphQL Playground est tel un bac-à-sable, c'est-à-dire un environnement de développement intégré (IDE) où il est possible de créer des scripts, quel que soit le langage utilisé. Ces scripts intègrent des requêtes GraphQL pour automatiser certaines tâches : par exemple, on pourrait imaginer une sauvegarde en local des données de Stylo! + +Comme vous avez pu voir, l'API GraphQL de Stylo est simple à utiliser. Il suffit de d'entrer le nom des données souhaitées ou les mutations voulues et l'application vous les donne. La formation se termine ici, il ne vous reste plus qu'à essayer différentes requêtes et mutations par vous-mêmes! -À venir. +Formation plus avancée à venir... From 95591dec010d791f9e5b23e7ef93760a40a64e73 Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Sat, 10 Feb 2024 09:43:21 -0500 Subject: [PATCH 15/22] Modifs api-graphql.md --- docs/src/fr/api-graphql.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/src/fr/api-graphql.md b/docs/src/fr/api-graphql.md index df813eb04..a7cf0a0fd 100644 --- a/docs/src/fr/api-graphql.md +++ b/docs/src/fr/api-graphql.md @@ -7,7 +7,7 @@ title: API GraphQL Stylo intègre dorénavant une API GraphQL à laquelle les utilisateurs peuvent avoir accès en lecture et en écriture. L'API donne accès aux données de Stylo grâce au langage de requête GraphQL. -Depuis l'*endpoint* [https://stylo.huma-num.fr/graphql](https://stylo.huma-num.fr/graphql), il devient possible de connecter Stylo à tout un ensemble de fonctionnalités réalisées par vos soins, donc sur mesure. +Depuis l'*endpoint* https://stylo.huma-num.fr/graphql, il devient possible de connecter Stylo à tout un ensemble de fonctionnalités réalisées par vos soins, donc sur mesure. Par exemple, l'API vous permet de récupérer vos articles et de les intégrer dans votre générateur de site statique préféré. GraphQL signifie **Graph Query Language**. C'est un langage de requête et un environnement d'exécution pour les interfaces de programmation d'application (API). C'est tout d'abord une création de Facebook en 2012, qui fut publié en libre accès en 2015. Vous obtenez de vos requêtes uniquement les données demandées et vous en définissez la structure. @@ -24,7 +24,8 @@ GraphQL signifie **Graph Query Language**. C'est un langage de requête et un en 1. Installer GraphQL -Si vous utilisez Google Chrome, il est facile d'installer l'extension. Vous pouvez choisir par exemple GraphQL Playground ou encore Altair GraphQL. Si vous voulez l'installer sur votre ordinateur et que vous avez brew, vous pouvez aussi entrer la commande « brew cask install graphql-playground ». Plusieurs options s'offrent à vous, si celles-ci ne vous conviennent pas vous pouvez en rechercher d'autres, ce ne sont que quelques suggestions. Pour cette formation, nous allons utiliser l'extension GraphQL Playground, mais vous pouvez aussi utiliser la version locale ou la [version web](https://legacy.graphqlbin.com/new). +Pour l'installation, vous pouvez vous référer au site...? + 2. Entrer l'URL @@ -106,8 +107,8 @@ query { Vous aurez peut-être remarqué que l'application vous offre des options d'autocomplétions lorsque vous écrivez. Cela vous donne des exemples de ce que vous pouvez demander par la suite. -Vous trouverez aussi une liste complète dans l'onglet à gauche de l'écran « Schema ». Si vous cliquez dessus, l'onglet s'ouvre. -L'onglet de documentation de l'API est l'une des fonctionnalités les plus intéressantes de GraphQL Playground. Il vous permet de prévisualiser toutes les requêtes et mutations possibles, ainsi que leurs détails en un seul champ d'un schéma donné. +Vous trouverez aussi une liste complète dans l'onglet à gauche de l'écran « Schema » ou dans certaines version « Doc ». Si vous cliquez dessus, l'onglet s'ouvre. +L'onglet de documentation de l'API est une fonctionnalités très intéressantes de GraphQL Playground. Il vous permet de prévisualiser toutes les requêtes et mutations possibles, ainsi que leurs détails en un seul champ d'un schéma donné. ![Schema](https://upload.wikimedia.org/wikipedia/commons/c/c6/Capture_d%E2%80%99%C3%A9cran_2024-01-23_184801.png) From e64e1beb2bbecd233cde5f99a39b051da515003b Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Thu, 22 Feb 2024 09:46:29 -0500 Subject: [PATCH 16/22] Apply suggestions from code review Co-authored-by: Thomas Parisot <138627+thom4parisot@users.noreply.github.com> --- docs/src/fr/api-graphql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/fr/api-graphql.md b/docs/src/fr/api-graphql.md index a7cf0a0fd..a2930e308 100644 --- a/docs/src/fr/api-graphql.md +++ b/docs/src/fr/api-graphql.md @@ -93,7 +93,7 @@ query articles { Pour ce dernier exemple, il vous faut encore une fois entrer votre identifiant d'article dans l'espace approprié. Cette fois-ci, GraphQL vous montre le titre de votre article, ceux qui y ont contribué, mais aussi le Markdown, Yaml et BibTex qu'il contient! -``` +```graphql Exemple 3 : query { article(article: " ID DE L'ARTICLE "){ From a98e086100aa60ceb02f8a67119700f5df2a7cea Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Thu, 22 Feb 2024 09:51:45 -0500 Subject: [PATCH 17/22] Update api-graphql.md avec changements de Roch --- docs/src/fr/api-graphql.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/src/fr/api-graphql.md b/docs/src/fr/api-graphql.md index a2930e308..139296291 100644 --- a/docs/src/fr/api-graphql.md +++ b/docs/src/fr/api-graphql.md @@ -22,10 +22,9 @@ GraphQL signifie **Graph Query Language**. C'est un langage de requête et un en ### Avant de commencer -1. Installer GraphQL - -Pour l'installation, vous pouvez vous référer au site...? +1. Installer un client GraphQL +Vous pouvez choisir votre client préféré, que ce soit GraphQL Playground, Altair ou autre. La démonstration qui suit est réalisée avec le client GraphQL Playground. 2. Entrer l'URL From 9108f6d2d4bae59d6128c15f969779411de08ede Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Thu, 22 Feb 2024 09:53:45 -0500 Subject: [PATCH 18/22] Update api-graphql.md avec la version fr --- docs/src/en/api-graphql.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/src/en/api-graphql.md b/docs/src/en/api-graphql.md index b907423b1..0ca48ad76 100644 --- a/docs/src/en/api-graphql.md +++ b/docs/src/en/api-graphql.md @@ -22,11 +22,9 @@ GraphQL stands for **Graph Query Language**. It's a query language and runtime e ### Before you start -1. Install GraphQL +1. Installing a GraphQL client -If you're using Google Chrome, it's easy to install the extension. You can choose, for example, GraphQL Playground or Altair GraphQL. If you want to install it on your computer and you have brew, you can also enter the command "brew cask install graphql-playground". There are a number of options available to you, and if these don't suit you, you can search for others - these are just a few suggestions. - -For this course, we'll be using the GraphQL Playground extension, but you can also use the local version or the [web version](https://legacy.graphqlbin.com/new). +You can choose your preferred client, be it GraphQL Playground, Altair or other. The following demonstration uses the GraphQL Playground client. 2. Enter the URL @@ -93,7 +91,7 @@ query articles { For this last example, once again you need to enter your article ID in the appropriate space. This time, GraphQL shows you not only the title of your article and the contributors, but also the Markdown, Yaml and BibTex it contains! -``` +```graphql Example 3 : query { article(article: "ARTICLE ID"){ @@ -140,4 +138,4 @@ GraphQL Playground is like a sandbox, an integrated development environment (IDE As you can see, Stylo's GraphQL API is easy to use. All you have to do is enter the name of the data you want, or the mutations you want, and the application gives them to you. That's all there is to it, and all that's left is for you to try out different queries and mutations for yourself! -More advanced training to come... \ No newline at end of file +More advanced training to come... From 0494a0789f8ed44e7cac13e53be21e4f1bd737e6 Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Thu, 22 Feb 2024 09:55:51 -0500 Subject: [PATCH 19/22] Correction des codes --- docs/src/en/api-graphql.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/en/api-graphql.md b/docs/src/en/api-graphql.md index 0ca48ad76..f59b0c28d 100644 --- a/docs/src/en/api-graphql.md +++ b/docs/src/en/api-graphql.md @@ -34,7 +34,7 @@ Once you've installed the extension or environment, make sure you enter the URL You also need to enter your API key. In the Stylo application, click on your name, the drop-down menu will open and then you click on your e-mail address. This will take you to your account information. This is where you'll find your key. Copy it. Back in GraphQL, on the bottom left is the "HTTP HEADERS" tab. Enter the key as follows: -``` +```graphql { "Authorization": "YOUR API KEY" } @@ -58,7 +58,7 @@ In the first example, we're asking for a list of all your articles contained in You can, of course, request other information as well. The possibilities are immense, and they go hand in hand with your needs. Don't forget to close the brackets after opening each one.When you're ready, click the execute button. -``` +```graphql Example 1: query allMyArticles { user { @@ -75,7 +75,7 @@ query allMyArticles { In example 2, you need to enter the identifier of one of the articles in the previous list. Keep it, as you'll need it for the last example too. Once you've entered the query, you should see the title of your item, as well as the person who owns it. -``` +```graphql Example 2: query articles { article(article: "ARTICLE ID"){ @@ -123,7 +123,7 @@ You can create articles, share your articles, duplicate them and much more. The Let's look at an example of a mutation: -``` +```graphql mutation{createArticle(title: "ARTICLE TITLE", user:" YOUR ID ") {title _id}} From 4301041ce2bb7eab0f8140fd1eea02dced8c37a5 Mon Sep 17 00:00:00 2001 From: cgermain97 <125378122+cgermain97@users.noreply.github.com> Date: Thu, 22 Feb 2024 09:56:38 -0500 Subject: [PATCH 20/22] Correction du code fr --- docs/src/fr/api-graphql.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/fr/api-graphql.md b/docs/src/fr/api-graphql.md index 139296291..cec3687c9 100644 --- a/docs/src/fr/api-graphql.md +++ b/docs/src/fr/api-graphql.md @@ -34,7 +34,7 @@ Une fois l'extension ou l'environnement installé, assurez-vous d'entrer dans le Il vous faut aussi entrer votre clé API. Dans l'application Stylo, cliquez sur votre nom, le menu déroulant s'ouvrira et vous cliquez ensuite sur votre adresse courriel. Cela vous mènera aux informations de votre compte. C'est dans cette section que vous trouverez votre clé. Copiez-la. De retour dans GraphQL, en bas à gauche se trouve l'onglet "HTTP HEADERS". Entrez la clé comme suis : -``` +```graphql { "Authorization":"VOTRE CLÉ API" } @@ -59,7 +59,7 @@ Ensuite, il faut spécifier le type de requête, dans le premier exemple, nous l Vous pouvez bien sûr demander d'autres informations. Les possibilités sont immenses et vont de pair avec vos besoins. Il ne faut pas oublier de refermer les crochets après l'ouverture de chacun. Quand vous êtes prêts cliquez sur le bouton d'exécution. -``` +```graphql Exemple 1 : query tousMesArticles { user { @@ -76,7 +76,7 @@ query tousMesArticles { Dans l'exemple 2, il vous faut entrer l'identifiant de l'un des article de la liste précédente. Gardez-le, vous en aurez aussi besoin pour le dernier exemple. Une fois la requête entrée, vous devriez voir le titre de votre article, ainsi que la personne qui le détient. -``` +```graphql Exemple 2 : query articles { article(article: " ID DE L'ARTICLE "){ @@ -123,7 +123,7 @@ Vous pouvez créer des articles, partager vos articles, les dupliquer et plus en Regardons un exemple de mutation : -``` +```graphql mutation{createArticle(title:"TITRE DE L'ARTICLE", user:" VOTRE ID ") {title _id}} From d43e299f1cda1c53ffc4448a1d91d2a1150d32e4 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Thu, 30 Nov 2023 16:34:01 +0100 Subject: [PATCH 21/22] init PR From 116b2983284297a3ccd2d4b8c6ddba2c040be4d5 Mon Sep 17 00:00:00 2001 From: RochDLY Date: Mon, 11 Mar 2024 09:26:19 +0100 Subject: [PATCH 22/22] correction erreur syntaxe dans le docker-compose.yaml --- docker-compose.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yaml b/docker-compose.yaml index e6c627ecf..293c69234 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -72,7 +72,7 @@ services: - graphql-stylo export-gateway: - image: "davidbgk/stylo-export:1.1.0 + image: "davidbgk/stylo-export:1.1.0" env_file: - stylo.env environment: