Merge branch 'main' into maintenance_curation.Rmd-pt-auto

Author: yabellini

.github/workflows/dev.yml

@@ -29,6 +29,7 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
+          cache-version: 3
           extra-packages: local::.
 
       - name: Render book

NAMESPACE

@@ -1,2 +1,3 @@
 # Generated by roxygen2: do not edit by hand
 
+export(translate_page)

R/translate.R

@@ -1,3 +1,28 @@
+#' Function translating one placeholder to actual content
+#'
+#' Also helps opening the PR
+#'
+#' @param page_path Path to the placeholder. First create on main,
+#' for instance to translate index.Rmd to Portuguese,
+#' first create a copy of index.Rmd as index.pt.Rmd on main.
+#' @param language Language to which to translate.
+#' See [docs of the `source_lang` and `target_lang` API parameters](https://www.deepl.com/docs-api/translate-text).
+#' @param glossary Glossary name.
+#'
+#' @details
+#' First follow babeldown docs to set the two environment variables.
+#'
+#' ```r
+#' Sys.setenv("DEEPL_API_URL" = "https://api.deepl.com")
+#' Sys.setenv(DEEPL_API_KEY = keyring::key_get("deepl"))
+#' ```
+#'
+#'
+#' @return Nothing
+#' @export
+#'
+#' @examples
+#' translate_page("index.pt.Rmd", "PT-BR")
 translate_page <- function(page_path, language, glossary = NULL) {
   git_branch_name <- sprintf(
     "%s-%s-auto",

README.md

@@ -32,7 +32,7 @@ Refer to [this blog post for more details and resources about bookdown deploymen
 
 If you're an associate editor, you can also push directly to `main` for small fixes. We shall use PRs to `main` for discussing larger updates.
 
-If you're an associate editor and you want to render the book locally you need to install `bookdown` and the other dependencies stated in [DESCRIPTION](DESCRIPTION) in particular use `devtools::install_github("bergant/airtabler")`, and [get and store an Airtable API key following their instructions](https://github.com/bergant/airtabler#get-and-store-the-api-key) (if you're not an editor, you don't have access to our Airtable base). Then use `bookdown::render_book('index.Rmd', 'bookdown::gitbook')` and the book will be generated in the `_book` folder; you can open the book on the command line by doing `open _book/index.html`.
+If you're an associate editor and you want to render the book locally you need to install Quarto and the other dependencies stated in [DESCRIPTION](DESCRIPTION) in particular use `pak::pak("bergant/airtabler")`, and [get and store an Airtable API key following their instructions](https://github.com/bergant/airtabler#get-and-store-the-api-key) (if you're not an editor, you don't have access to our Airtable base). Then use `bookdown::render_book('index.Rmd', 'bookdown::gitbook')` and the book will be generated in the `_book` folder; you can open the book on the command line by doing `open _book/index.html`.
 
 # Meta
 

_quarto.yml

@@ -38,7 +38,6 @@ book:
     The third section also features a chapter for anyone wishing
     to start contributing to rOpenSci packages.
   cover-image: images/cover.png
-  reader-mode: true
   site-url: https://devguide.ropensci.org/
   repo-url: https://github.com/ropensci/dev_guide/
   repo-actions: [edit, issue]
@@ -99,6 +98,13 @@ format:
     include-in-header: "preamble.tex"
     output-file: "ropensci-dev-guide"
 babelquarto:
+  languagecodes:
+  - name: es
+    text: "Español"
+  - name: en
+    text: "English"
+  - name: pt
+    text: "Português"
   mainlanguage: en
   languages: ['es', 'pt']
 title-pt: title in pt

booknews.Rmd

@@ -2,6 +2,8 @@
 
 ## dev (0.9.0)
 
+- 2024-01-09, update roxygen2 wording (`@vincentvanhees`, #792).
+
 - 2023-12-15, update roxygen2 advice, mainly linking to roxygen2 website (#750).
 
 - 2023-09-15, add suggestions for API packages (#496).

index.Rmd

@@ -14,7 +14,7 @@ u <- "https://zenodo.org/record/2553043" # universal URL redirects to latest
 s <- rvest::session(u)
 u <- paste0(s$url, "/export/bibtex") # redirected
 out <- rvest::read_html(u)
-bibentry <- rvest::html_text(rvest::html_element(out, "pre"))
+bibentry <- rvest::html_text(out)
 cat(bibentry)
 cat("\n```\n")
 ```

maintenance_collaboration.pt.Rmd

@@ -10,17 +10,19 @@ aliases:
 We will help you promoting your package but here are some more things to keep in mind.
 ```
 
-- If you hear of an use case of your package, please encourage its author to post the link to our [discussion forum in the Use Cases category](https://discuss.ropensci.org/c/usecases), [for a tweet from rOpenSci and possible inclusion in the rOpenSci biweekly newsletter](https://discuss.ropensci.org/t/about-the-usecases-category/33). We also recommend you to add a link to the use case in a "use cases in the wild" section of your README.
+- If you hear of an use case of your package, please encourage its author to post the link to our [discussion forum in the Use Cases category](https://discuss.ropensci.org/c/usecases), [for a toot (Mastodon post) from rOpenSci and inclusion in the rOpenSci monthly newsletter](https://discuss.ropensci.org/t/about-the-usecases-category/33). We also recommend you to add a link to the use case in a "use cases in the wild" section of your README.
+
+- Post about your package on Mastodon using the "#rstats" hashtag and tag rOpenSci! This might help with contributor/user engagement. Example posts from rOpenSci itself: [A package a day](hachyderm.io/@rOpenSci/111611705648653729), [Help wanted post](hachyderm.io/@rOpenSci/111460729804231877), [Use cases](hachyderm.io/@rOpenSci/111371091053569287), [Welcome post]( hachyderm.io/@rOpenSci/111342069863172097).
 
 - When you [release](#releasing) a new version of your package or release it to CRAN for the first time,
 
   - Make a pull request to [R Weekly](https://github.com/rweekly/rweekly.org) with a line about the release under the "New Releases" section (or "New Packages" for the first GitHub/CRAN release).
 
-  - Tweet about it using the "#rstats" hashtag and tag rOpenSci! This might help with contributor/user engagement. [Example](https://twitter.com/opencpu/status/1003934871830622208).
+  - Post about it on social media.
 
   - Consider submitting a short post about the release to [rOpenSci tech notes](https://ropensci.org/technotes/). Contact rOpenSci Community Manager, (e.g. via Slack or [[email protected]](mailto:[email protected])). Refer to [the guidelines about contributing a blog post](https://blogguide.ropensci.org)).
 
-  - Submit your package to lists of packages such as [CRAN Task Views](https://cran.r-project.org/web/views/), and [rOpenSci non-CRAN Task Views](https://github.com/search?utf8=%E2%9C%93&q=user%3Aropensci+%22task+view%22&type=Repositories&ref=searchresults).
+  - Submit your package to lists of packages such as [CRAN Task Views](https://cran.r-project.org/web/views/).
 
 - If you choose to market your package by giving a talk about it at a meetup or conference (excellent idea!)
   read [this article of Jenny Bryan's and Mara Averick's](https://www.tidyverse.org/articles/2018/07/carpe-talk/).

maintenance_marketing.Rmd

@@ -6,24 +6,25 @@ repo-actions: true
 
 ```{block, type="summaryblock"}
 Te ayudaremos a promocionar tu paquete, pero aquí hay algunas cosas más para tener en cuenta.
-```
 
-- Si te enteras de un caso de uso de tu paquete, anima a quien lo escribió a publicar el enlace en nuestro [foro de debate en la categoría Casos de uso](https://discuss.ropensci.org/c/usecases), [para recibir un tweet de rOpenSci y su posible inclusión en el boletín quincenal de rOpenSci](https://discuss.ropensci.org/t/about-the-usecases-category/33).
+- Si te enteras de un caso de uso de tu paquete, anima a quien lo escribió a publicar el enlace en nuestro [foro de debate en la categoría Casos de uso](https://discuss.ropensci.org/c/usecases), [para recibir un toot (mensaje en Mastodon) de rOpenSci y su posible inclusión en el boletín mensual de rOpenSci](https://discuss.ropensci.org/t/about-the-usecases-category/33).
   También te recomendamos que añadas un enlace al caso de uso en la sección "casos de uso reales" de tu archivo *README*.
 
 - Cuando [publiques](#releasing) una nueva versión de tu paquete o lo publiques en CRAN por primera vez,
   
+- Comparte sobre el paquete en Mastodon utilizando el hashtag "#rstats" y etiqueta a rOpenSci!
+    Esto puede ayudar llegar a gente que pueda colaborar o usar el paquete.
+   Ejemplos enviados desde rOpenSci mismo: ["A package a day" (un paquete al dia)](hachyderm.io/@rOpenSci/111611705648653729), [Help wanted (se necesita ayuda)](hachyderm.io/@rOpenSci/111460729804231877), [Use case (caso de uso)](hachyderm.io/@rOpenSci/111371091053569287), [Welcome post (mensaje de bienvenida)]( hachyderm.io/@rOpenSci/111342069863172097).
+    
   - haz un *pull request* a [R Weekly](https://github.com/rweekly/rweekly.org) con una mensaje sobre la versión en la sección "*New Releases*" (o "*New Packages*" para la primera versión de GitHub/CRAN).
   
-  - ¡Tuitea sobre ello utilizando el hashtag "#rstats" y etiqueta a rOpenSci!
-    Esto puede ayudar llegar a gente que pueda colaborar o usar el paquete.
-    [Por ejemplo](https://twitter.com/opencpu/status/1003934871830622208).
+  - Comparte en tus redes sociales.
   
   - Considera enviar un breve artículo sobre el lanzamiento a [rOpenSci tech notes](https://ropensci.org/technotes/).
     Ponte en contacto con la persona encargada de gestionar la comunidad de rOpenSci, (por ejemplo, a través de Slack o [[email protected]](mailto:[email protected])).
     Consulta [las recomendaciones sobre cómo contribuir con un artículo en el blog](https://blogguide.ropensci.org)).
   
-  - Envía tu paquete a listas de paquetes como [*CRAN Task Views*](https://cran.r-project.org/web/views/), y [rOpenSci non-CRAN Task Views](https://github.com/search?utf8=%E2%9C%93&q=user%3Aropensci+%22task+view%22&type=Repositories&ref=searchresults).
+  - Envía tu paquete a listas de paquetes como [*CRAN Task Views*](https://cran.r-project.org/web/views/).
 
 - Si decides promocionar tu paquete dando una charla sobre él en una reunión o conferencia (¡excelente idea!) lee en [este artículo de Jenny Bryan y Mara Averick (en inglés)](https://www.tidyverse.org/articles/2018/07/carpe-talk/).