Adding a blog entry to scala-lang is simple – we use Jekyll (see the README in the root of this repository for Jekyll setup instructions in case you don't have Jekyll installed.)
A blog article is a larger instructional/opinion/informational original piece. An example is the blog article that we published about running our first Coursera course in December 2012, Functional Programming Principles in Scala: Impressions and Statistics. News items or announcements on the other hand are just that – short news flashes announcing something, whether it be a new release, a new project, a new course, or anything in between.
If you realize you should be writing a blog article instead of a news item,
see the README in the /blog directory of this repository for instructions on
how to add a blog article to our feed (both blog articles and news items show up
in the same place on the front page of scala-lang.org)
- Create a markdown file in the
/news/_postsdirectory of this repository named according to the convention:YYYY-MM-DD-name-for-your-news-item.md - Add some YAML frontmatter. For example: (Note that you can specify
post-typeto be eithernewsorannouncement!)
---
layout: news
post-type: news
by: Joe Schmoe
title: Uber Cool New Release!
---
- Write your post in markdown following the front matter.
- Run Jekyll locally and double-check your article for formatting and correctness! To do so, simply run
jekyll serve --watchfrom the root of the repository. Note that the--watchoption enables incremental rebuilding, so each time you change a file, the site is regenerated and re-served. To visit your news item, go to:localhost:4000/path/to/your/news/item - Make a pull request!