Merge pull request #227 from r-devel/quarto

🏗️ Convert book to Quarto

.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+on:
+  workflow_dispatch:
+  push:
+    branches: main
+
+name: Quarto Publish
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Render and Publish
+        uses: quarto-dev/quarto-actions/publish@v2
+        with:
+          target: gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -10,3 +10,6 @@ rdevguide.tex
 
 # temp files
 *~
+
+/.quarto/
+_book

_quarto.yml

@@ -0,0 +1,52 @@
+project:
+  type: book
+
+book:
+  title: "R Development Guide"
+  author: "R Contribution Working Group"
+  date: today
+  favicon: img/favicon.png
+  site-url: https://contributor.r-project.org/rdevguide
+  repo-url: https://github.com/r-devel/rdevguide
+  repo-branch: main
+  repo-actions: [edit, issue]
+  chapters:
+    - index.qmd
+    - introduction.qmd
+    - getting_started.qmd
+    - issue_tracking.qmd
+    - reporting_bugs.qmd
+    - submitting_feature_requests.qmd
+    - reviewing_bugs.qmd                
+    - finding_the_source.qmd             
+    - lifecycle_of_a_patch.qmd
+    - documenting.qmd                    
+    - message_translations.qmd         
+    - testing_pre_release_r_versions.qmd
+    - r_core_developers.qmd
+    - where_to_get_help.qmd              
+    - news_and_announcements.qmd   
+    - developer_tools.qmd             
+
+format:
+  html:
+    theme: cosmo
+    include-in-header: header.html
+    description-meta: "This guide is a comprehensive resource for contributors (from all levels, beginners, intermediate, and seasoned) to the R project, facilitating their onboarding and helping them navigate the contribution process."
+  pdf:
+    documentclass: scrreprt
+    include-in-header: preamble.tex
+    include-before-body: frontpage.tex
+  epub:
+    cover-image: img/cover_page_scriberia.png
+
+# book_filename: "rdevguide"
+# chapter_name: "Chapter "
+# repo: https://github.com/r-devel/rdevguide
+# url: 'https\://contributor.r-project.org/rdevguide/'
+# github-repo: "r-devel/rdevguide"
+# output_dir: docs
+# clean: [packages.bib, bookdown.bbl]
+# new_session: yes
+# edit: https://github.com/r-devel/rdevguide/edit/main/%s
+# delete_merged_file: true

header.html

@@ -1,10 +1,3 @@
-<link rel="shortcut icon" href="img/favicon.png" />
 <!-- see https://plausible.io/contributor.r-project.org%2Frdevguide for analytics dashboard -->
 <script defer data-domain="contributor.r-project.org/rdevguide" src="https://plausible.io/js/plausible.js"></script>
 
-<script>
-// add little icons to top left of note box
-$( document ).ready(function() {
-  $(".note").append("<div class='note-icon'><img src='img/information.svg'></img></div>")
-});
-</script>

index.Rmd → index.qmd

@@ -1,24 +1,6 @@
---- 
-title: "R Development Guide"
-author: "R Contribution Working Group"
-date: "`r Sys.Date()`"
-site: bookdown::bookdown_site
-output: bookdown::gitbook
-documentclass: book
-bibliography: [book.bib]
-biblio-style: apalike
-link-citations: yes
-github-repo: r-devel/rdevguide
-url: https://contributor.r-project.org/rdevguide
-cover-image: "img/cover_page_scriberia.png"
-favicon: "img/Rlogo.svg"
-description: "This guide is a comprehensive resource for contributors (from all levels, beginners, intermediate, and seasoned) to the R project, facilitating their onboarding and helping them navigate the contribution process."
-
----
-
 # {-}
 
-![R Development Guide. This illustration is created by Scriberia with The Turing Way community, used under a CC-BY 4.0 licence. DOI:= https://zenodo.org/records/13882307](img/r-development-guide.jpg){height=400px width=550px}
+![R Development Guide. This illustration is created by Scriberia with The Turing Way community, used under a CC-BY 4.0 licence. DOI:= https://zenodo.org/records/13882307](img/r-dev-guide-without-text.jpg){height=400px width=550px}
 
 # Acknowledgement {-}
 

06-reviewing_bugs.Rmd → reviewing_bugs.qmd

@@ -36,11 +36,11 @@ These helpful tasks allow the Core developers and/ or maintainers to classify a
 
 ## Example of a bug review submitted on Bugzilla
 
-If you would like to see how bugs are reviewed on Bugzilla, the [Bug 16542 - nlme:::summary.lmList with unequal outputs per group](https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16542) is an example where an old bug report is being reviewed. It is tested to see if it was still an issue and a few ways are proposed to resolve the issue.
-
-**Note**:
+If you would like to see how bugs are reviewed on Bugzilla, the [Bug 16542 - `nlme:::summary.lmList` with unequal outputs per group](https://bugs.r-project.org/bugzilla/show_bug.cgi?id=16542) is an example where an old bug report is being reviewed. It is tested to see if it was still an issue and a few ways are proposed to resolve the issue.
 
+::: {.callout-note}
 There is a `#bug-reporting` channel on the [R Contributors slack](https://r-contributors.slack.com/) where you can share your bug report(s) for review/feedback before submitting to Bugzilla. This can help with checking that it really is a bug, that you have included the important information and excluded redundant information.
+:::
 
 ## See also