Skip to content

Release Editor FAQ

Sam Parmar edited this page Jun 13, 2022 · 14 revisions

Tasks

Schedule

https://docs.google.com/spreadsheets/d/1rc1klvh0915mCTKigen7XocTfkuzBKw7L03GsbocULw/edit?usp=sharing

R Weekly Team Space will replace rbot for several task

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide

Step by step

Step 1: aggregate links to draft

  • Create a draft with links gathered from GitHub PRs, R Weekly Live (see @rbot notes below), Slack #links-api channel posts, Twitter, Reddit, and other sources

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#1-draft

This can be done on Friday or early on Saturday.

Step 2: highlight

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#3-highlight

This can be done on Friday or early on Saturday.

Step 3: add images

  • Pick a few images from some of the articles to include in the newsletter, and add a copy of these to the RWeekly Image repo (this is done to avoid bloating the size of the main repo).
  • Link to the images using https and the https://raw.githubusercontent.com domain

e.g. ![Connecting Arduino Chips with R](https://raw.githubusercontent.com/rweekly/image/master/2019/ar_plotter.png)

  • Images should have a maximum width of 800px

This step is less time sensitive so can be done immediately after step 1 & 2, or at a later stage before release

Step 4: release

  • Release a new issue on Monday, by creating a new article in _posts.
  • Add the featured articles/links (based on the voting outcome) to the top Highlight section (this means that featured articles will appear twice - both in the highlight section and in whichever category they fall into).

This post should be name YYYY-MM-DD-YYYY-NN where the three first are the date, the second part being the ID of the release (year + number of the release). The header should be

---
title: R Weekly YYYY-NN TITLE
description: Weekly News in the R Community.
image: https://rweekly.org/public/facebook.png
---

Just change YYYY-NN TITLE

Go to rbot on slack and ask to update cache

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#4-update-cache

update-cache https://rweekly.org/

Release a new draft

Be careful to migrate "upcoming event" to the new draft (if still in the time span)

Related Tools

1. Generate Links from R Weekly Live

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#1-draft

talk to @rbot

help

live-range-md 2018-12-22 2018-12-31

2. Determine which CRAN packages are new and which are updated

With this script sourced you can highlight a set of items including CRAN links then run process_versions() in an RStudio console to assess which items are new to CRAN (only have one version) or have been updated (have more than one version). The result is printed to the console and can be copied back to the appropriate section. Links in the original copied text will not be removed.

Alternatively, this script will provide new or updated CRAN packages as markdown text for you via process_cranberries(). See the script for an example of how to use the function. The function will also provide diffify links for updated packages.

3. Generate R Weekly Highlights Poll

https://github.com/rweekly/rweekly.highlights

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#3-highlight

4. About Images

R Weekly always uses HTTPS. To fix mixed content warning for images that are using HTTP, ask the copyright holder of the image for permission and put a copy of the image in rweekly/image repo.

If an image is very big, please consider using https://cdn.jsdelivr.net/gh/rweekly/image/...... For example, https://cdn.jsdelivr.net/gh/rweekly/image/2019/ggplot2-flipbook.gif

5. Update Website Cache

https://github.com/rweekly/rweekly.org/wiki/R-Weekly-Team-Space-Guide#4-update-cache

Talk to rbot, use direct message or @rbot in the channel

use update-cache https://rweekly.org/ will update the home page cache use update-cache https://rweekly.org/draft.html will update the draft cache

cmd + shift + R to refresh web page and it may take some minutes to update.