Skip to content
This repository stores the content used in our static Jekyll based website. If you need to make a change to the website please submit a PR to this repository with your changes.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_authors Added the Lund Linux Conf Blog Post (#689) Jun 13, 2019
_company member-update-190522-1923 (#668) May 22, 2019
_core Fix for closing of wiki.linaro.org - updated the /engineering/consume… Jun 10, 2019
_data Artificial Intelligence Reference Fix (#685) Jun 11, 2019
_engineering Removing the media embed to see if production site renders markdown c… Jun 11, 2019
_includes Artificial Intelligence Reference Fix (#685) Jun 11, 2019
_layouts Added markdown='1' to the landing-page.html layout (#680) Jun 4, 2019
_pages Added the Lund Linux Conf Blog Post (#689) Jun 13, 2019
_plugins Added a small cache buster plugin to generate timestamps on each buil… Jul 4, 2018
_posts Added the Lund Linux Conf Blog Post (#689) Jun 13, 2019
_projects Modified the Board page and syncing changes from Develop branch/ Clou… Jun 3, 2019
_services Corrected icon Oct 16, 2018
app Fixed broken link in the app/ subfolder Oct 8, 2018
assets Added the Lund Linux Conf Blog Post (#689) Jun 13, 2019
remote Fix for closing of wiki.linaro.org - updated the /engineering/consume… Jun 10, 2019
.gitignore Bugfix for Planet Linaro on Safari browsers (#541) Jan 25, 2019
Gemfile Updated Linaro.org to latest version of the Jekyll theme with site bu… May 28, 2019
Gemfile.lock Modified the Board page and syncing changes from Develop branch/ Clou… Jun 3, 2019
README.md HPC Sig Page Updated - Membership page updates (related news/testimon… Jan 15, 2019
_config-production.yml Moving to the inherited configuration file approach. The _config-stag… Oct 18, 2018
_config-staging.yml Moving to the inherited configuration file approach. The _config-stag… Oct 18, 2018
_config.yml Modified the Board page and syncing changes from Develop branch/ Clou… Jun 3, 2019
favicon.ico Added the standard favicon.ico Apr 16, 2018
index.html Added the homepage title (#673) May 28, 2019
siteicon.png Modified the Board page and syncing changes from Develop branch/ Clou… Jun 3, 2019

README.md

Linaro.org Static Jekyll Site

Welcome to the official content repository for Linaro's static Jekyll based website. Hosted in this repo are the markdown content files associated with the website. Feel free to submit a PR / Issue if there is anything you would like to change.


Guides

Below are a few guides that will help when adding content to the Linaro website.


Addding a new page

Step 1 - Choose url and layout

Static Jekyll web pages are placed in folders in the root of the website with either a README.md or a index.html page beneath them. Example - /services/README.md or /services/index.html. This keeps the pages organised to some extent. If you page contains mostly HTML then use index.html so that IDE's recognize it has HTML and README.md if the page is mostly markdown.

The url for your page should be added to the front matter of your posts (the section at the top of the file between --- containing yaml) as the permalink. This will ensure the url of your page is exactly as you intended it to be. See below for an example of the front matter to add to the page. If in any doubt please duplicate a page that you would like yours to look like and modify the file from there.

---
# Layout of your web page - see below for available layouts.
layout: container-breadcrumb-tabs
# URL of your web page
permalink: /services/
# Title of your web page
title: Services Page
# Description of your web page.
desc: |-
    Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy 
    text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has
    survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was 
    popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop
    publishing software like Aldus PageMaker including versions of Lorem Ipsum.
# Keywords that describe your page used as meta keywords.
keywords: lorem, ipsum, web, page
---

Available layouts

Below are a table showing the available layouts for you to use:

Layout Description Image
container-breadcrumb This layout contains the standard breadcrumb and centered content container for you to use. container-breadcrumb layout
container-breadcrumb-tabs Same as the above layout but includes the HTML for the sticky tab bar. container-breadcrumb-tabs layout
product-display-page This is the layout used by product pages on the 96Boards website. product-display-page layout
post This the layout used for blog posts. If you supply a featured image a header with the featured image will be added. This image is also used when sharing on social media sites. default layout
default This is the default layout used by other layouts. Use this if you want to add custom HTML for content. default layout

Adding a blog post

In order to add a blog post to Linaro.org copy an existing post from the _posts folder. Posts are organised into by year/month so add to the correct folder based on the month you are posting it in and if the folder doesn't exist create one.

Step 1 - Modify the post file name

The url for your post is based on the title provided in the filename e.g 2018-06-07-announcing-women-in-stem.md will have a url of /blog/announcing-women-in-stem/. Separate the words in your title by dashes and modify the date at the start of the filename as neccessary.

Step 2 - Modify the post front matter

Modify the post front matter based on your post. Values to modify are:

  • author:
  • date:
  • image:
  • tags:
  • description:
  • categories:

E.g

---
title: The emerging AI Deep Learning Neural Network Ecosystem and why we need to collaborate
author: linaro
layout: post
date: 2018-09-07 09:00:00+00:00
description: >-
  Linaro will be hosting an AI and Neural Networks on Arm Summit at the upcoming Linaro Connect Vancouver 2018 in one weeks time. This blog lists some of the great sessions being presented.
categories: blog
tags: Arm, Linaro, Machine Learning, AI, Deep Learning, Neural Networks
image:
  featured: true
  path: /assets/images/blog/OSSNA.jpg
---

Jekyll Post Categories

There are three post categories to choose from:

  • News
  • Blog
  • Resource

News Posts

News posts are reserved for Linaro.org press releases and are rendered under the /news/ permalink. Use "News" as the Jekyll post category to push a Linaro.org news press release.

Blog Posts

Blog posts are used for general Linaro.org blog post updates. These can range from technical posts to Linaro business oriented "Informal" updates. To create a blog post that is rendered under the /blog/ permalink then please add "Blog" as the Jekyll post categoroy.

Resource Posts

Resource posts are reserved for Linaro.org event resource oriented posts. When we attend events which have Linaro employees spekaing we will add a Resource post that contains links to the event resources. This will also allow us to loop through all Resource posts and index/search them at /resources/

Author

Change the author to a unique author username (e.g firstname.surname). If this is your first time posting then add your author information to the _authors collection by duplicating an existing author's .md file and modifying the values appropiately. Make sure to add your profile image to the /assets/images/authors folder. Verify that the author "username:" in the _authors/ collection file for your author is an exact match to that provided as the author: in your post. Doing the above will ensure your author image and pages are rendered correctly on the Linaro.org website.

Date

Modify the date to sometime before you post the blog otherwise Jekyll will see it as a future post and not render it until the time on the server exceeds/equals that provided as the date in the post front matter.

Image

This value is used for the featured image displayed on your blog post and the image that is used when sharing the blog post on social media sites.

image:
    featured: true
    path: /assets/images/blog/image-name.png
    name: image-name.png
    thumb: image-name.png 
    

Make sure that the image you add in this section of front matter is placed in the /assets/images/blog folder.

Note: There is currently a bug with the version of jekyll-assets we are using which means the only acceptable image extensions are .jpg and .png. If you use .jpeg you image may not display as expected.

Tags

These should be modified based on the content of your post as they are used for Meta keywords so that people can find your post based on the tags your provide.

Description

Change this value to a short description of your blog post as this is used as the meta description of your blog post.

Categories

There are two categories to choose from:

  • News
  • blog

Set one or the other in the front matter of your post. If you add the "blog" category your post will show under /blog/ whereas if you add the "News" category your post will display under the /news/ section.

Step 3 - Add your post content.

Write your post content in Markdown format; specifically the Kramdown Markdown flavour.

Adding images

Please use the following code snipppet to add an image to your blog post. Make sure to add the images that you include to /assets/images/blog folder.

{% include image.html name="name-of-your-image.png" alt="The Alt text for your image" %}

You also align/scale your image using the following css classes.

Class Details
small-inline Small image aligned to the left
small-inline right Small image aligned to the right
medium-inline Medium image aligned to the left
medium-inline right Medium image aligned to the right
large-inline Large image aligned to the left
large-inline right Large image aligned to the right
{% include image.html name="name-of-your-image.png"  class="medium-inline" alt="The Alt text for your image" %}

Using this Jekyll include will allow your images to be lazy loaded and format the image HTML correctly.

Adding code

We are using the rouge syntax highlighter to highlight your glorious code.

$ bundle exec jekyll serve --port 1337

See the full list of languages here.

Adding Media/YouTube videos

To add a media element / YouTube video use the following Jekyll include.

{% include media.html media_url="https://youtu.be/GFzJd0hXI0c" %}

Adding Redirects to the Static site

We are using Edge-rewrite which is a rewrite engine running in Lambda@Edge. The redirects are to be added to the _data/routingrules.json file in the webiste repository following the syntax rules here.

^/oldpath/(\\d*)/(.*)$ /newpath/$2/$1 [L]
!^/oldpath.*$ http://www.example.com [R=302,L,NC]
^/topsecret.*$ [F,L]
^/deadlink.*$ [G]
^/foo$ /bar [H=^baz\.com$]

Note: These redirects are currently not respected by the link checker until built. So if trying to fix broken links by adding redirects then this may not be the best way to go about it currently.


Adding events to the events page

Adding Other Events

Events listed on the events/ page are added through simply adding the event:true front matter value to your event page. The events will then be listed based on the date value in front matter of that specific page.

...
event: true
...

Adding Connect Events

Connect events are added through the _data/connects.yml data file. Simply copy and existing entry in this file and add the new Connect event. Make sure to update the date specified in the entry as this is what is used to make sure the events are listed in the correct order (most recent first).

- id: YVR18
  placeholder: yvr18.jpg
  long-name: Linaro Connect Vancouver 2018
  start-date: 2018-09-17 09:00:00
  end-date: 2018-09-21 09:00:00
  location:
      venue: Hyatt Regency Vancouver
      city: Vancouver
      country: Canada

Building the static site

In order to build the Linaro.org static site make sure you have Ruby and the bundler/jekyll gems installed. For instructions on how to setup an environment to build Jekyll sites see the official Jekyll documentation here.

Once you have above installed you can simply clone this repo and run the following:

$ bundle 

This will install the required gems listed in the Gemfile.

$ bundle exec jekyll s 

This will serve (s) the Jekyll static website to the http://localhost:4000 where you can view the generated static website.

Known Issues

Rendering Liquid syntax on a post/page

On very rare occasions you may need render/output Liquid (or code that uses the same syntax as Liquid) to a post/page. If you need to do this make sure you escape the opening Liquid tag like shown below:

{{ "{{ "{{" }} .... }}" }}
{{ "{{ "{%" }}... %}" }}
You can’t perform that action at this time.