Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.27 KB

Creating a Jekyll Post

To contribute to this blog, please create a post on a topic your choice.

The file should be added to the _posts directory and should have file name similar to YYYY-MM-DD-post-title.md. It is important that the post file name begin with the year/month/day information for the post.

The post file should include the following "frontmatter" before any content or text:

---
layout: post
title:  My Post
author: My Name
---

The layout: post attribute is required. The title tag is required and the value here will appear as the title of the user's browser window. The author tag is optional.

The remainder of file should be the text for your blog post, written in markdown syntax.

Style Guide

You post should start with a paragraph of lead-in text. This is used as the excerpt on the front page of the website.

There should be no h1-style headings, please use h2 or smaller. An h2 heading in markdown look like:

## My Heading

More leading # symbols mean a smaller heading.

Categories

To differentiate between target audiences, there are some predetermined categories for each post to belong to. Assign a category using the category: tag in your post's frontmatter.

Category Name Audience
setup ROSS installation details
walkthrough These ordered posts are for first time model developers
model-dev More advanced topics for model developers
feature Detailed documentation for various ROSS features
ross-dev Advanced topics for developers working on ROSS core
announcement Announcements relevant to the ROSS community

By having an established set of categories, the Archives page clearly differentiates between topics for ROSS users (model developers) and topics for ROSS developers.

Submitting Your Post

Submit your post as part of a pull-request for the gh-pages branch of the ROSS repository.

Resources

  • The initial Markdown standard, from Daring Fireball: link
  • GitHub Markdown guide: link
  • Basics of Jekyll blogging: link.