rOpenSci website
Clone or download
Latest commit 372f6fa Jan 19, 2019

readme.md

logo

rOpenSci website

Welcome to the new (October 2017) website for the rOpenSci project. Our old website (repo, site) is now archived and all new content should be added to this repository. For any issues with the site including typos or rendering issues, please file an issue or send a pull-request. The site automatically deploys once pull requests are merged.

TOC

Contributing a blog post

To contribute a blog post (🙏):

See editorial suggestions below

  1. Fork the repo
  2. Create a new file in /content/blog/YEAR-MONTH-DAY-short-slug.md
  3. Your post must include YAML in this format:
---
slug: "treestartr"
title: Generating reasonable starting trees for complex phylogenetic analyses
package_version: 0.1.0
authors:
  - April Wright
date: 2018-12-11
categories: blog
topicid:
tags:
- software-peer-review
- r
- community
- software
- packages
- treestartr
- phylogeny
- paleontology
- fossils
- divergence-time
---

  1. If your blog post has any images (or other assets), create a folder under themes/ropensci/static/img/blog-images/ with the pattern <DATE-SLUG> (e.g. 2018-12-11-treestartr) and place them there. To reference any of these objects in your post, use /img/blog-images/<DATE-SLUG>/name-of-image.png. If the paths are correct, you should see the preview render correctly (see next step).

  2. Once you've drafted your blog post, you can preview locally using Hugo or skip to the next step to preview on the pull request. See technical notes section for installation instructions if you wish to preview locally.

  3. Send a pull request from your fork one week prior to the post date to allow time for review. Netlify will start building the new version of the site within seconds and you can preview you changes to make sure everything looks as intended. Otherwise push additional fixes till things look right.

  1. Tag a rOpenSci staff member to review your pull request (@stefaniebutland, @sckott, @jeroen, or @karthik)

Blog post editorial suggestions

For a post about your peer-reviewed package you should:

  • browse other posts about peer-reviewed packages with tag 'software-peer-review'
  • consider giving some narrative on motivation for creating the package, or something you learned in the process, and share an interesting use case
  • acknowledge reviewers by name with links to their GitHub or Twitter; no need to explicitly acknowledge the editor
  • acknowledge other contributors, if any
  • consider ending by pointing to open issues that readers might work on
  • include YAML tag "software-peer-review" and tags that were topic labels in your package review
  • browse other tags, and re-use either the plural or singular form of an existing tag e.g. "packages" exists, so use that, rather than "package"
  • if you would like a specific image from your post to be featured in tweets that include a link to your post, add to YAML twitterImg: img/blog-images/<DATE-SLUG>/name-of-image.png. Omit the leading /
  • to format headings in your post, please use ### or ####, as larger sizes don't look good

For a post about your experience as a reviewer you can browse other posts with tag 'reviewer'

Create an author's index file for yourself, if you don't already have one, by adding _index.md in roweb2/content/authors/firstname-lastname/ with information about your online presence. Keep accents in your name. If you're not sure of how to slugify/urlize your name, look at other people's folder names for examples.

Example roweb2/content/authors/kelly-obriant/_index.md:

---
name: Kelly O'Briant
link: https://kellobri.github.io/
twitter: kellrstats
---

The link field is meant for your preferred online presence URL (personal website, GitHub account, etc.). Thetwitter field is for your Twitter username (without "@").

Then when a reader clicks on your by-line in your blog post, tech note, or a community call you have presented in, they can see how to find you online, as well as seeing a list of all of these you have contributed. See for example, Kelly O'Briant's author page.

Installation requirements

There are no requirements to simply add a post/fix and push to GitHub for a render preview on a pull request. However, if you wish to preview the site locally, you must install Hugo.

Installing Hugo for local preview

The current version of hugo on the server uses is defined in netlify.toml. To install hugo locally:

brew install hugo

Then run hugo serve in the repo directory to start a local server on http://localhost:1313. To view a future-dated blog post, use hugo serve -F.

Updating page templates

For other website issues and updates, see developer-notes .

Acknowledgements

The rOpenSci project is a fiscally sponsored project of NumFOCUS and based at the University of California, Berkeley. The project is funded by grants from various public and private institutions and from donations.

Contents of this website are licensed as CC-BY unless otherwise noted. All fonts are licensed for use on this domain and may require a separate license to use elsewhere.