update branch

.all-contributorsrc

@@ -36,7 +36,10 @@
         "question",
         "eventOrganizing",
         "talk",
-        "video"
+        "video",
+        "review",
+        "example",
+        "research"
       ]
     },
     {
@@ -63,7 +66,12 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/6818218?v=4",
       "profile": "http://llrs.dev",
       "contributions": [
-        "review"
+        "review",
+        "content",
+        "question",
+        "research",
+        "doc",
+        "example"
       ]
     },
     {
@@ -73,7 +81,9 @@
       "profile": "http://tdhock.github.io",
       "contributions": [
         "review",
-        "example"
+        "example",
+        "research",
+        "question"
       ]
     },
     {
@@ -82,7 +92,9 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/3341603?v=4",
       "profile": "https://github.com/bettinagruen",
       "contributions": [
-        "review"
+        "review",
+        "research",
+        "question"
       ]
     },
     {
@@ -119,7 +131,10 @@
       "profile": "https://github.com/MichaelChirico",
       "contributions": [
         "review",
-        "question"
+        "question",
+        "content",
+        "doc",
+        "research"
       ]
     },
     {
@@ -178,12 +193,36 @@
       "contributions": [
         "review"
       ]
+    },
+    {
+      "login": "nbenn",
+      "name": "nbenn",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3158446?v=4",
+      "profile": "https://github.com/nbenn",
+      "contributions": [
+        "review",
+        "research",
+        "question"
+      ]
+    },
+    {
+      "login": "benubah",
+      "name": "Ben",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11357251?v=4",
+      "profile": "https://github.com/benubah",
+      "contributions": [
+        "content",
+        "review",
+        "research",
+        "question"
+      ]
     }
   ],
   "contributorsPerLine": 7,
   "projectName": "rdevguide",
   "projectOwner": "r-devel",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "angular"
 }

.github/workflows/deploy_bookdown.yml

@@ -11,14 +11,19 @@ jobs:
     name: Render-Book
     runs-on: macOS-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: r-lib/actions/setup-r@v1
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: actions/checkout@v3
+      - uses: r-lib/actions/setup-r@v2
+      - uses: r-lib/actions/setup-pandoc@v2
+      - uses: r-lib/actions/setup-tinytex@v2
       - name: Install rmarkdown
         run: Rscript -e 'install.packages(c("rmarkdown","bookdown"))'
-      - name: Render Book
-        run: Rscript -e 'bookdown::render_book("index.Rmd")'
-      - uses: actions/upload-artifact@v1
+      - name: Render HTML
+        run: Rscript -e 'bookdown::render_book("index.Rmd", "bookdown::gitbook")'
+      - name: Render PDF
+        run: Rscript -e 'bookdown::render_book("index.Rmd", "bookdown::pdf_book")'
+      - name: Render ePub
+        run: Rscript -e 'bookdown::render_book("index.Rmd", "bookdown::epub_book")'
+      - uses: actions/upload-artifact@v3
         with:
           name: docs
           path: docs/

01-Introduction.Rmd

@@ -6,7 +6,7 @@ This guide is heavily influenced by the [Python Developer Guide](https://devguid
 
 This guide is built using bookdown which makes editing it easier, provided you have a GitHub account (sign-up at [github.com](https://github.com/)). After you log-in to GitHub, click on the ‘Edit’ icon highlighted with a red ellipse in the image below. This will take you to an editable version of the the source R Markdown file that generated the page you are on:
 
-![](https://user-images.githubusercontent.com/28556616/122679827-03314a80-d20a-11eb-9714-06ae588127f0.png)
+![Screenshot of the toolbar in the HTML version of the guide, with the Edit button (pencil and paper icon) circled in red.](img/edit_icon.png)
 
 Use the [issue tracker](https://github.com/forwards/rdevguide/issues) to raise an issue about the guide’s content or to make a feature request.
 

04-reviewing_bugs_in_R.Rmd

@@ -40,7 +40,7 @@ If you would like to see how bugs are reviewed on Bugzilla, [here](https://bugs.
 
 **Note**:
 
-There is a `#bugreports-for-review` 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.
+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
 

07-documenting_R.Rmd

@@ -68,7 +68,7 @@ The language used in the documentations should follow these basic rules:
 
 3. Short code examples can help in understanding better. Readers can often grasp a simple example more quickly than they can digest a formal description. Usually people learn faster with concrete, motivating examples that match the context of a typical use case. 
 
-4. Giving a code equivalent (or approximate equivalent) can be a useful in addition to the description provided. You should carefully weigh whether the code equivalent adds value to the document.
+4. Giving a code equivalent (or approximate equivalent) can be a useful addition to the description provided. You should carefully weigh whether the code equivalent adds value to the document.
 
 5. The tone of the documentation needs to be respectful of the reader’s background. Lay out the relevant information, show motivating use cases, provide glossary links, and do your best to connect-the-dots. The documentation is meant for newcomers, many of whom will be using it to evaluate the R language as a whole. The experience needs to be positive and not leave the reader with worries that something bad will happen if they make a mistake.