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

Author: yabellini

.github/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+### Suggestions and updates
+
+This book contains our guidelines for packages contributed to [the rOpenSci suite of packages](https://ropensci.org/packages/). 
+They are always a work in progress - corrections, suggestions and general improvements are welcome as [issue submissions in this repository](https://github.com/ropensci/dev_guide/issues/new). 
+Open discussions are welcome in our [forum](https://discuss.ropensci.org/). 
+You can also suggest changes by editing the `.Rmd` files that are at the root of this repository and submitting a pull request.  
+An "edit" button in all book chapters will take you directly to the relevant page on GitHub to make such changes. 
+Please target your pull requests to the `main` branch.
+
+### Technical details
+
+Deployment is done via [GitHub Actions](.github/workflows).
+The book has a [production version](https://devguide.ropensci.org/) and a [development version](https://devdevguide.netlify.com/).
+Both are updated when there are changes in their sources but also once a day to ensure the reviewers list is up to date (data pulled from Airtable).
+
+* [prod.yml](.github/workflows/prod.yml): whenever there's a GitHub release, the book is built and its content is then pushed to the `gh-pages` branch. That branch serves ropensci.github.io/dev_guide which is redirected to https://devguide.ropensci.org/
+
+* [scheduled-manual-main.yml](scheduled-manual-main.yml): once a day the book is built with the source from the latest release (see "Checkout latest release tag" step) and pushed to the `gh-pages` branch.
+
+* [dev.yml](.github/workflows/dev.yml): whenever there's a push to the default branch `main`, and once a day, the book is built and its content is then pushed to the `dev-site` branch that gets [deployed to Netlify](https://devdevguide.netlify.com/).
+
+* [pr.yml](.github/workflows/dev.yml): whenever there's a pull request to the default branch `main`, the book is built and its content is deployed via Netlify.
+
+Refer to [this blog post for more details and resources about bookdown deployment on GitHub Actions](https://ropensci.org/blog/2020/04/07/bookdown-learnings/#5-how-to-deploy-a-preview-of-the-book-for-pull-requests).
+
+### Notes for associate editors
+
+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 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 but you can still build the book, although the Airtable info will be missing). 
+Then use `babelquarto::render_book()` and the book will be generated in the `_book` folder; you can open the book by for instance running `servr::httw("_book")`.
+
+### How to maintain translations
+
+Any commit to main that edits a page with translations (say, `index.Rmd`) needs to also update the translations. 
+If you have a PR open, with commits to a chapter in one language you can either provide your own translations, 
+generate automated translations, or request translations from the maintenance team.
+
+- For your own translations, follow the guidance in the [rOpenSci Localization and Translation Guidelines](https://translationguide.ropensci.org)
+
+- To generate automated translations, you can use the {babeldown} package, wheich requires an API key from [DeepL](https://www.deepl.com). [`babeldown::deepl_update()`](https://docs.ropensci.org/babeldown/reference/deepl_update.html) generates translations to edited sections of the `.Rmd` (see this [blog post](https://ropensci.org/blog/2024/01/16/deepl-update-babeldown/)), and should be used once per translated langauge. 
+
+- If you are unable to provide your own or automated translations, for support for complex translations, or just tiny changes, (one sentence or so), tag the `@ropensci/dev-guide` team in your PR to request support from the maintainer team.
+
+The PR will require a reviewer for each language.
+
+# Meta
+
+All of the content of this repository is licensed 
+[CC-BY-SA](https://creativecommons.org/publicdomain/zero/1.0/).
+
+You can cite this book using [its Zenodo metadata and DOI](https://doi.org/10.5281/zenodo.2553043).

.github/workflows/prod.yml

@@ -5,48 +5,48 @@ on:
 
 name: Rerender-released-Book
 
+
 jobs:
   bookdown:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     name: Render-Book
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@main
+      - uses: actions/checkout@v2        
         with:
           fetch-depth: 0
-
+            
       - name: Checkout latest release tag
         run: |
           LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
           git checkout $LATEST_TAG
 
       - uses: r-lib/actions/setup-r@v2
 
+      - uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: pre-release
+
       - uses: r-lib/actions/setup-pandoc@v2
 
       - uses: r-lib/actions/setup-tinytex@v2
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: |
-            any::bookdown
+          extra-packages: local::.
 
-      - name: Render book html
-        run: Rscript -e 'bookdown::render_book("index.Rmd", "bookdown::bs4_book", params = list(AIRTABLE_API_KEY = ${{ secrets.AIRTABLE_API_KEY }}))'
+      - name: Render book
+        run: Rscript -e 'babelquarto::render_book()'
         env: # Set the secret as an input
           AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
           ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
 
-      - name: Render book PDF
-        run: Rscript -e 'bookdown::render_book("index.Rmd", new_session = FALSE, "bookdown::pdf_book", output_dir = "pdfbook", params = list(AIRTABLE_API_KEY = ${{ secrets.AIRTABLE_API_KEY }}))'
-        env: # Set the secret as an input
-          AIRTABLE_API_KEY: ${{ secrets.AIRTABLE_API_KEY }}
-          ZENODO_TOKEN: ${{ secrets.ZENODO_TOKEN }}
+      - name: Move English files
+        run: Rscript -e 'file.copy(from = "_book/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'
 
-      - name: Move files around
-        run: Rscript -e 'file.copy(from = "pdfbook/ropensci-dev-guide.pdf", to = "_book/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/images")'
+      - name: Move Spanish files
+        run: Rscript -e 'file.copy(from = "_book/es/rOpenSci-Packages--Development,-Maintenance,-and-Peer-Review.pdf", to = "_book/es/ropensci-dev-guide.pdf")' -e 'purrr::walk(list.files("images", full.names = TRUE), file.copy, to = "_book/es/images")'
 
       - name: git config
         run: |

.github/workflows/scheduled-manual-main.yml

@@ -9,7 +9,7 @@ Imports:
     babelquarto,
     gert,
     humaniformat,
-    rvest,
+    purrr,
     usethis,
     withr
 Remotes: 

DESCRIPTION

@@ -4,42 +4,9 @@ rOpenSci Packages: Development, Maintenance, and Peer Review
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) 
 [![DOI](https://zenodo.org/badge/126815002.svg)](https://zenodo.org/badge/latestdoi/126815002)
 
-rOpenSci's guide for packages in our suite. [Read it here](https://devguide.ropensci.org/).
+rOpenSci's [guide for packages in our suite](https://devguide.ropensci.org/).
+[Development version](https://devdevguide.netl).
 
 ## Contributing
 
-### Suggestions and updates
-
-This book contains our guidelines for packages contributed to [the rOpenSci suite of packages](https://ropensci.org/packages/). They are always a work in progress - corrections, suggestions and general improvements are welcome as [issue submissions in this repository](https://github.com/ropensci/dev_guide/issues/new). Open discussions are welcome in our [forum](https://discuss.ropensci.org/). You can also suggest changes by editing the `.Rmd` files that are at the root of this repository and submitting a pull request.  An "edit" button at the top of all book chapters will take you directly to the relevant page on GitHub to make such changes. Please target your pull requests to the `main` branch.
-
-### Technical details
-
-Deployment is done via [GitHub Actions](.github/workflows).
-The book has a production version https://devguide.ropensci.org/ and a development version https://devdevguide.netlify.com/
-Both are updated when there are changes in their sources but also once a day to ensure the reviewers list is up to date (data pulled from Airtable).
-
-* [prod.yml](.github/workflows/prod.yml): whenever there's a GitHub release, the book is built and its content is then pushed to the `gh-pages` branch. That branch serves ropensci.github.io/dev_guide which is redirected to https://devguide.ropensci.org/
-
-* [scheduled-manual-main.yml](scheduled-manual-main.yml): once a day the book is built with the source from the latest release (see "Checkout latest release tag" step) and pushed to the `gh-pages` branch.
-
-* [dev.yml](.github/workflows/dev.yml): whenever there's a push to the default branch `main`, and once a day, the book is built and its content is then pushed to the `dev-site` branch that gets [deployed to Netlify](https://devdevguide.netlify.com/).
-
-* [pr.yml](.github/workflows/dev.yml): whenever there's a pull request to the default branch `main`, the book is built and its content is deployed via Netlify.
-
-Refer to [this blog post for more details and resources about bookdown deployment on GitHub Actions](https://ropensci.org/blog/2020/04/07/bookdown-learnings/#5-how-to-deploy-a-preview-of-the-book-for-pull-requests).
-
-### Notes for associate editors
-
-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 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
-
-This book was started using [Sean Kross](https://github.com/seankross)' [minimal bookdown example](https://github.com/seankross/bookdown-start).
-
-All of the content of this repository is licensed 
-[CC-BY-SA](https://creativecommons.org/publicdomain/zero/1.0/).
-
-You can cite this book using [its Zenodo metadata and DOI](https://doi.org/10.5281/zenodo.2553043).
-
+See [contributing guide](.github/CONTRIBUTING.md).

README.md

@@ -1,6 +1,6 @@
 # NEWS {#booknews}
 
-## dev (0.9.0)
+## 0.9.0
 
 - 2024-01-09, update roxygen2 wording (`@vincentvanhees`, #792).
 

booknews.Rmd

@@ -23,3 +23,7 @@ code {
 .summaryblock > a {
   color: #d8dfee;
 }
+
+.quarto-title-meta {
+  display: block !important;
+}

custom.scss

@@ -8,15 +8,7 @@
 #| echo: false
 #| results: 'asis' 
 #| warning: false
-#| eval: fase
-cat("\n```bibtex\n")
-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(out)
-cat(bibentry)
-cat("\n```\n")
+source(file.path("scripts", "zenodo.R"), local = knitr::knit_global())
 ```
 
 You can also read the [PDF version](/ropensci-dev-guide.pdf) of this book.

index.Rmd

@@ -2,22 +2,13 @@
 
 <a href="https://doi.org/10.5281/zenodo.2553043"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.2553043.svg?branch=master" alt="DOI"></a>
 
-<a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/3.0/us/deed.es"><img alt="Licencia Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png" /></a><br /> Esta obra está bajo [una Licencia Creative Commons Atribución-NoComercial-CompartirIgual 3.0 Estados Unidos de América](https://creativecommons.org/licenses/by-nc-sa/3.0/us/deed.es). Consulta [el DOI de Zenodo](https://doi.org/10.5281/zenodo.2553043) para saber como citarla.
-
-
-```{r} 
-#| eval: fase
-#| echo: false
-#| results: 'asis' 
-#| warning: false
-cat("\n```bibtex\n")
-u <- "https://zenodo.org/record/2553043" # universal URL redirects to latest
-s <- rvest::session(u)
-u <- paste0(s$url, "/export/hx") # redirected
-out <- rvest::read_html(u)
-bibentry <- rvest::html_text(rvest::html_element(out, "pre"))
-cat(bibentry)
-cat("\n```\n")
+<a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/3.0/us/deed.es"><img alt="Licencia Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png" /></a><br /> Esta obra está bajo [una Licencia Creative Commons Atribución-NoComercial-CompartirIgual 3.0 Estados Unidos de América](https://creativecommons.org/licenses/by-nc-sa/3.0/us/deed.es). Consulta [el DOI de Zenodo](https://doi.org/10.5281/zenodo.2553043) de la version original y [el DOI de la traducción](https://zenodo.org/doi/10.5281/zenodo.10797248) para saber como citarlas.
+
+Ejemplo:
+
+```
+rOpenSci editorial team (2024). Paquetes rOpenSci: Desarrollo, mantenimiento y revisión por pares [rOpenSci Packages: Development, Maintenance, and Peer Review] (Traducción al español: Yanina Bellini Saibene, Elio Campitelli, Paola Corrales) Zenodo. https://zenodo.org/doi/10.5281/zenodo.10797248 (Trabajo original publicado en 2024)
+
 ```
 
 También puedes leer la [versión PDF de este libro](/ropensci-dev-guide.pdf).

index.es.Rmd

@@ -4,19 +4,11 @@
 
 <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/3.0/us/"><img alt="Licença Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png" /></a><br /> Este trabalho está licenciado com uma licença [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License](https://creativecommons.org/licenses/by-nc-sa/3.0/us/). Utilize o [Zenodo DOI](https://doi.org/10.5281/zenodo.2553043) para citar esta obra.
 
-```{r} 
-#| eval: fase
+```{r}
 #| echo: false
 #| results: 'asis' 
 #| warning: false
-cat("\n```bibtex\n")
-u <- "https://zenodo.org/record/2553043" # universal URL redirects to latest
-s <- rvest::session(u)
-u <- paste0(s$url, "/export/hx") # redirected
-out <- rvest::read_html(u)
-bibentry <- rvest::html_text(rvest::html_element(out, "pre"))
-cat(bibentry)
-cat("\n```\n")
+source(file.path("scripts", "zenodo.R"), local = knitr::knit_global())
 ```
 
 Você também pode ler a [versão em PDF](/ropensci-dev-guide.pdf) deste livro.