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.
Clone or download
EbbaSimpson Merge pull request #401 from EbbaSimpson/develop
Renamed the YVR18 blog and made some corrections
Latest commit 160e42c Sep 21, 2018
Permalink
Failed to load latest commit information.
_authors Removed duplicate of Alex Bennee Aug 9, 2018
_company Added the Analog Devices page Sep 13, 2018
_core Fixed broken link to the open-source-security project Jul 18, 2018
_data Added Analog Devices to the members db Sep 13, 2018
_groups Updated the group ids to change the order the logos are displayed on … Aug 28, 2018
_includes Fixed linking issue with the homepage slider Aug 29, 2018
_incubators Added initial text to the /engineering/incubators/ page Aug 28, 2018
_initiatives Merged with upstream Aug 16, 2018
_layouts Removed the members output from the work page layout Aug 28, 2018
_plugins Added a small cache buster plugin to generate timestamps on each buil… Jul 4, 2018
_posts Renamed the YVR18 blog and made some corrections Sep 21, 2018
_projects Projects removed and initiatives renamed to projects Jul 18, 2018
_services Updated all instances of ARM to Arm on Linaro.org Jun 7, 2018
_sig Added the new group logos to the respective pages Aug 8, 2018
about Added linebreaks below the view policy button Sep 12, 2018
app Fixed broken link in the app/ folder used by other Linaro services Aug 30, 2018
assets Merge branch 'develop' into develop Sep 21, 2018
authors Added redirect for author/ to authors/ Jul 10, 2018
blog Removed the Core Dev Blog title Jun 4, 2018
categories Removed old assets folder - merged with master and fixed conflicts Apr 4, 2018
company Updated the layout used on the events/armhpcjapan2017/ page Apr 23, 2018
contact Fixes for broken links to pages that have had permalinks changed in r… Jun 25, 2018
core Added the core page to stop broken links from displaying - redirects … Jun 25, 2018
developers Replaced all instances of http://connect.linaro.org with https://conn… Aug 16, 2018
downloads/images Downloads and Security page moved to /engineering/ Jun 25, 2018
engineering Sorted the projects we contribute to by name Aug 31, 2018
events Updated the events.scss and the events/ page to show website link and… Aug 31, 2018
latest Update Downloads page to link to new GNU toolchain on Arm site Sep 12, 2018
leg/servercluster Updated all instances of ARM to Arm on Linaro.org Jun 7, 2018
legal Updated the text on the gdpr page Sep 12, 2018
linarolife Removed the linarolife pages and added redirects instead Apr 16, 2018
members-by-group Added the members-by-group/ page to list the members by group Aug 21, 2018
membership Sorting the projects we contribute to by name Aug 31, 2018
news Added the security page to the Downloads dropdown / changed the title… Apr 18, 2018
planet Merged upstream with the themed branch Apr 16, 2018
press Changed JS package to main Jul 30, 2018
professional-services Changed the layouts used by content pages Feb 20, 2018
remote Replaced all instances of http://connect.linaro.org with https://conn… Aug 16, 2018
search Toggled the order display for the search Apr 24, 2018
sitemap Changed the layouts used by content pages Feb 20, 2018
thank-you Changed the layouts used by content pages Feb 20, 2018
work Replaced links to pages that have been removed/have had permalinks ch… Jul 12, 2018
.gitignore Added modified Gemfile.lock to stop issues with build... Jun 25, 2018
404.md Updated the Linaro.org 404 page Apr 17, 2018
Gemfile Updated the Gemfile with updated theme to open Connect tab in same br… Aug 20, 2018
Gemfile.lock Added the updated Gemfile.lock Aug 20, 2018
README.md Added template to the README Sep 10, 2018
_config-production.yml Updated the config files chaning the default layout used for the _com… Jul 26, 2018
_config-staging.yml Updated the config files chaning the default layout used for the _com… Jul 26, 2018
_config.yml Updated the config files chaning the default layout used for the _com… Jul 26, 2018
_prose.yml Adding Metadate to root files Feb 1, 2018
favicon.ico Added the standard favicon.ico Apr 16, 2018
index.html Home page updated Jun 7, 2018
members.json Added JSON ouput for the Linaro Members Jul 17, 2018
siteicon.png Added 'siteicon.png' via CloudCannon Aug 20, 2018

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.


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
  name: OSSNA.jpg
  path: /assets/images/blog/OSSNA.jpg
---

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:

{{ "{{ "{{" }} .... }}" }}
{{ "{{ "{%" }}... %}" }}