diff --git a/vignettes/A-convertir-une-app-shiny-en-app-shiny-dsfr.Rmd b/vignettes/A-convertir-une-app-shiny-en-app-shiny-dsfr.Rmd index 464edc4..0c2eec9 100644 --- a/vignettes/A-convertir-une-app-shiny-en-app-shiny-dsfr.Rmd +++ b/vignettes/A-convertir-une-app-shiny-en-app-shiny-dsfr.Rmd @@ -20,7 +20,7 @@ library(shinygouv) # convert_to_dsfr -La fonction expérimentale convertit tous les composants shiny présents dans les fichiers du dossier "R/" d'une application shiny, en composant dsfr, si et seulement si ceux ci ont été implémentés dans la {version} définie en paramètre. +La fonction expérimentale `convert_to_dsfr()` convertit tous les composants shiny présents dans les fichiers du dossier "R/" d'une application shiny, en composant dsfr, si et seulement si ceux ci ont été implémentés dans la {version} définie en paramètre. Cette fonction va modifier les fichiers de votre application, présents dans le répertoire `path`. Il reste des points de vigilances sur la conversion des tabPanel dans les navbarPage et les tabsetPanel. @@ -47,7 +47,7 @@ De plus, elle ajoute la dépendance au package {shinygouv} dans le fichier `app_ ## Conversion -Pour cela, il suffit de lancer dans votre projet contenant l'application shiny: +Pour cela, il suffit de lancer dans la console depuis votre projet contenant l'application shiny : ```{r eval = FALSE} diff --git a/vignettes/Dev-A-guide-du-developpeur.Rmd b/vignettes/Dev-A-guide-du-developpeur.Rmd index 0ac6c0c..0d4c468 100644 --- a/vignettes/Dev-A-guide-du-developpeur.Rmd +++ b/vignettes/Dev-A-guide-du-developpeur.Rmd @@ -13,6 +13,15 @@ knitr::opts_chunk$set(echo = TRUE, eval = FALSE) Ceci est un dossier de documentation dédié aux développeurs et développeuses. Il contient les choix de mode de développement et tout autre document qui ne s'adresserait pas directement aux utilisateurs. + +## Structuration du repo (a compléter) + +Le développement de ce package a été réalisé avec {fusen} : les fonctions, vignettes et test sont générées par des fichiers Rmd dans le dossier /dev. + +Le repo contient deux app : +- une app de demo des composant de shinygouv : que l'on peut visualiser avec shinygouv::run_app(), +- une app de test pour la fonction de conversion convert_to_dsfr(), présente dans "inst/test.convert.dsfr/". + ## Version du framework dsfr en cours de développement Pour s'assurer du bon développement du package `shinygouv`, il a été ajouté au fichier `DESCRIPTION` la version du dsfr utilisé. @@ -33,6 +42,10 @@ Lorsque vous aurez implémenté toutes les composantes avec la nouvelle version, desc::desc_set("VersionDsfr" = "1.7.2") ``` +#### Ressources utiles : + +- Notes de versions du dsfr https://www.systeme-de-design.gouv.fr/a-propos/versions/version-courante +- Notes de versions shiny : https://github.com/rstudio/shiny/blob/main/NEWS.md ## Workflow à suivre avant de dev sur le projet : diff --git a/vignettes/Dev-C-montee-en-version-du-dsfr-trouver-les-fichiers-css-et-js.Rmd b/vignettes/Dev-C-montee-en-version-du-dsfr-trouver-les-fichiers-css-et-js.Rmd index 63d54eb..0085db7 100644 --- a/vignettes/Dev-C-montee-en-version-du-dsfr-trouver-les-fichiers-css-et-js.Rmd +++ b/vignettes/Dev-C-montee-en-version-du-dsfr-trouver-les-fichiers-css-et-js.Rmd @@ -24,6 +24,11 @@ library(shinygouv) knitr::opts_chunk$set(eval = FALSE) ``` +## Comment savoir ce qui a été mis à jour ? +Le principe de ce package est de proposer une transposition des fonctions de {shiny} à la charte graphique Marque Etat grâce au [design system de l'Etat](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/. Pour savoir si une montée de version est nécessaire, consultez les notes de versions du dsfr sur https://www.systeme-de-design.gouv.fr/a-propos/versions/version-courante. + +Egalement, les fonctions shiny transposées peuvent évoluer : consultez ici les notes de versions de shiny : https://github.com/rstudio/shiny/blob/main/NEWS.md. + Dans le dossier "inst/" du package, nous allons créer deux dossiers: - un pour récolter les css et js du dsfr,