From c54287b0338f89075191009dcfbc03ff0cc6ac94 Mon Sep 17 00:00:00 2001
From: Diego H <diego.hernangomezherrero@gmail.com>
Date: Mon, 8 Jul 2024 16:08:39 +0200
Subject: [PATCH] =?UTF-8?q?A=C3=B1ade=20art=C3=ADculo?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 vignettes/rostemplate.Rmd | 151 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 151 insertions(+)
 create mode 100644 vignettes/rostemplate.Rmd

diff --git a/vignettes/rostemplate.Rmd b/vignettes/rostemplate.Rmd
new file mode 100644
index 0000000..6aed4ba
--- /dev/null
+++ b/vignettes/rostemplate.Rmd
@@ -0,0 +1,151 @@
+---
+title: "Usando rostemplate"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Usando rostemplate}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+Esta librería es una plantilla **pkgdown** adaptada al sitio web de
+[rOpenSpain](https://ropenspain.es/).
+
+Esta plantilla es una plantilla privada para uso exclusivo de los paquetes de
+**rOpenSpain**. Por favor, no la uses para otros paquetes.
+
+## Introducción
+
+Este paquete proporciona una plantilla de **pkgdown** adaptada a la empleada por
+la comunidad [rOpenSpain](https://ropenspain.es/), que a su vez es una
+adaptación de la plantilla
+[Universal](https://bootstrapious.com/p/universal-business-e-commerce-template)
+creada por
+[Bootstrapius](https://bootstrapious.com/p/universal-business-e-commerce-template)
+con la variación de color **violet**.
+
+## Configuración previa
+
+En la raíz del proyecto ha de existir un archivo `_pkgdown.yml` con al menos las
+siguientes líneas:
+
+``` yaml
+template:
+  bootstrap: 5
+  package: rostemplate
+  # No pongas la siguiente línea!
+  default_assets: false
+```
+
+Puedes encontrar información sobre cómo configurar otras opciones en
+`_pkgdown.yml` [aquí](https://pkgdown.r-lib.org/articles/pkgdown.html).
+
+Adicionalmente, es necesario añadir al archivo `.Rbuildignore` las siguientes
+líneas:
+
+``` default
+^\.github$
+^docs$
+^_pkgdown\.yml$
+```
+
+## Uso de la plantilla
+
+Esta sección detalla diferentes opciones para generar un sitio estático para el
+paquete deseado con el formato definido por esta plantilla. El resultado de este
+paso es la generación de un sitio estático compuesto de los archivos `html`,
+`css`, etc. basados en el paquete de **R** para el que se está generando el
+sitio.
+
+### Con GitHub actions - CI
+
+GitHub Actions permite automatizar procesos cuando se activa un *trigger*. En
+este caso se han preparado dos acciones que actualizan el sitio estático cada
+vez que se añade un *commit* al repositorio.
+
+Los flujos de trabajo consisten en archivos con extensión `.yaml`. La acción
+[rostemplate-docs.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-docs.yaml)
+crea el sitio estático en la carpeta `./docs` mientras que
+[rostemplate-gh-pages.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-gh-pages.yaml)
+crea el sitio estático en el branch `gh-pages`.
+
+Para configurar esta opción, es necesario disponer en el repositorio de una
+carpeta en la ruta `.github/workflows` y copiar la acción deseada en dicha
+carpeta.
+
+#### Alternativa usando las funciones de rostemplate
+
+Aunque el uso del paquete **rostemplate** en si no es necesario con GitHub
+actions, se han desarrollado dos funciones que automatizan esta configuración de
+manera automática. Estas funciones simplemente crean el directorio
+`.github/workflows` si no existiera previamente y copian los archivos
+solicitados en la ruta correspondiente. Adicionalmente, crean los archivos
+`.Rbuildignore` y `.github/.gitignore`, que ignoran ciertos archivos cuando se
+compila el paquete:
+
+```{r eval=FALSE}
+# Instalación via r-universe
+
+install.packages("rostemplate",
+  repos = c("https://ropenspain.r-universe.dev", "https://cloud.r-project.org")
+)
+
+# Deploy to gh-branch
+
+rostemplate::ros_actions_pkgdown_branch()
+
+
+# Deploy to docs folder
+rostemplate::ros_actions_pkgdown_docs()
+```
+
+Es posible cambiar el evento que desencadena la actualización del sitio:
+
+``` yaml
+# Actualiza en cada commit - por defecto
+on:
+  push:
+    branches:
+      - main
+      - master
+      
+# Actualiza cuando se modifica un archivo específico: _pkgdown.yaml
+
+on:
+  push:
+    paths:
+      - '_pkgdown.yaml'
+```
+
+Más información sobre cómo adaptar los *triggers* de la acción
+[aquí](https://docs.github.com/es/free-pro-team@latest/actions/reference/events-that-trigger-workflows).
+
+### RStudio - manual
+
+El sitio estático se puede generar igualmente desde una sesión local en
+**RStudio**. Para ello, es necesario instalar este paquete:
+
+```{r eval=FALSE}
+install.packages("rostemplate",
+  repos = c("https://ropenspain.r-universe.dev", "https://cloud.r-project.org")
+)
+```
+
+Una vez instalado, se ha de ejecutar este script:
+
+```{r eval=FALSE}
+rostemplate::ros_build()
+```
+
+La función `rostemplate::ros_build()` no es más que un alias de
+`pkgdown::build_site()`, aportando únicamente un control sobre la configuración
+del archivo `_pkgdown.yml`
+
+Una vez generado el sitio, es necesario actualizar el repositorio remoto en
+GitHub mediante un *commit*.
+
+## GitHub Pages
+
+Una vez generado el sitio estático y subido al repositorio en GitHub, el último
+paso es activar el sitio web a través de los *Settings* de nuestro repositorio
+(*Setting\>GitHub Pages*), seleccionando el origen deseado (`gh-pages`,
+`main/docs`, etc.).