Skip to content

Style Guide: Events & Blog

Katherine Simeon edited this page Apr 30, 2020 · 1 revision

Events

Create & Save an Event File

Events are posted to our website as "Talks" (i.e. using the talks widget in the academic theme). The Website_Event_Template.md file in the blog repo is the template for creating new events.

Upon filling out the website template, please rename the .md file as the date of the meetup and the meetup name. More specifically:

  • If the event is a regular, in-person, monthly meetup, the file name should be: YYYY-MM-DD-Meetup.md
  • If the event is a study group meeting or a smaller group meeting, the file name should be: YYYY-MM-DD-SGNAME.md (i.e.
    2018-07-09_NLP.md)

This file should be saved in the development branch in content >> talk. Images should be saved in static >> img >> events.

Event Descriptions

For maintaining consistency, use the following conventions when filling out certain fields of the template:

In the header:

For title = "" use the name of the event that matches with what is posted on our meetup page. If this is a study group meeting or a smaller meeting that might not be posted on meetup, writing "Astrostatistics Study Group Meeting" is sufficient.

For event = "" start with the sub-group that's meeting, the month, then the type of event. For example:

  • For meetups, the event field should say: R-Ladies Chicago MONTH EVENT_TYPE[Technical/Social] Meetup
    E.g. R-Ladies Chicago August Technical Meetup
  • For study groups, the event field should say: Study Group Name MONTH Meeting
    E.g. NLP Study Group August Meeting

The longer event description should include:

  • A 1-sentence summary about what the event is (this could be the text that is used on the meetup event)
  • An email or method of contact if someone wants more information
  • Any important must-read requirements about attendance
  • A link to the Code of Conduct

For more specific guidelines on writing an event description, see our template for writing a meetup event description.

Blog Posts

The purpose of our blog is to showcase diverse perspectives in the R-Ladies Chicago community and to highlight the events we host within the Chicago chapter. More specifics on our vision for blog content can be found here.

Creating a Blog Post File

The blog post author should use the blog post template in our blog repo and update all the fields appropriately.

Blog posts should be submitted as a single .Rmd file with no other supplementary files necessary (i.e., data should be stored and pulled remotely).

One way to do this is via RCurl:

Require("RCurl")
library(RCurl)
DAT_Rladies<-read.csv(text=getURL("https://raw.githubusercontent.com/rladies-chicago/2018-12-05-meetup/master/data/meetup.csv")) 

At the end of the blog post, please include a brief bio of the author. Feel free to include links to a twitter handle, personal website, github, or etc.!

Adding Blog Post to Website

Upon receiving a blog submission:

  • Proofread and knit the .Rmd file to ensure that it works.
  • Ensure all URLs work
  • Add any tags that might be useful in the header under tags: [""]
  • Format date as YYYY-MM-DDTT

This file should be saved in the development branch in content >> post.