New Issue Checklist - RetroAchievements/RANews GitHub Wiki

RANews checklist

System Requirements

  • Have Jekyll installed. Note: If you're familiar with docker, you don't need to install Jekyll.
  • Have a way to run a bash script (native on Linux/MacOS, requires some tweaks on Windows).
  • Have a git client installed.
  • Optional but suggested: Visual Studio Code (makes git commands easier)

Steps to release a new RANews issue

  • create a dirs /_issues/yyyy-mm/ and the img subdir

  • get the cover.png and put it in /_issues/yyyy-mm/img

  • change the front-matter of the /index.html, putting the current issue's dir in the currentIssue variable. Example: currentIssue: /issues/2021-09/

  • get from Hotscrock the txt file with data for RnR, Hotcheevs and ArtUpdates.

    • run the generate-articles.sh script with the txt file to generate the 3 articles.
  • get the top mastery images and put them in /_issues/yyyy-mm/img

    • The images' filenames MUST follow this pattern: top-mastery-${consoleNickname}. See examples here
  • articles

    • intro - talk a bit about what to expect from this issue
    • editorial - something the "editor" want to say to the readers
    • hotcheevs monthly - copy'n'paste generated article
    • revisions'n'rescores - copy'n'paste generated article
    • art updates - copy'n'paste generated article
    • top players - copy'n'paste Xymjak's file
    • play-this-set 10 mini-articles - get from the wiki
    • most wanted games - get data (ok), and create the images???
    • current events - HolyShinx gets data from this forum post
    • community works - when community members do a shareable RA-related thing, we advertise in a dedicated page.
    • DevTip
    • Fun - currently SporyTike
    • RAViews
    • RAGuide - picked by ViperZang
    • custom article(s)?
  • commit the changes to the repository