Linaro.org Static Jekyll Site

This is the git repository for Linaro's static Jekyll-based website https://www.linaro.org.

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.

This static Jekyll site is using the jumbo-jekyll-theme. Please take a moment to review the guides on the theme's GitHub wiki.

Contributing

To make it easier to contribute to the content, Linaro provides a couple of Docker containers for building and checking the site. All you need is Docker installed on your computer and enough RAM and disc space.

To build the site:

cd <git repository directory>
SKIP_JEKYLL_DOCTOR="true" ./build-site.sh

To build the site and then serve it so that you can check your contribution appears:

cd <git repository directory>
JEKYLL_ACTION="serve" SKIP_JEKYLL_DOCTOR="true" ./build-site.sh

To check that your contribution doesn't include any broken links:

cd <built web site directory>
../check-links.sh

The built web site directory will be production.linaro.org.

For more information, please see the build container wiki and the link checker wiki.

Guides

Generic guides for Linaro static websites based on the jumbo-jekyll-theme:

• Adding a new page
• Adding a blog post
• Building the static site

Linaro.org specific guides:

TODO

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

URL Redirections

Redirection rules are defined in _data/routingrules.json. Please note that if the left hand side does not reference a file then it must end with (/?|/index.html)$ otherwise the URL will not match.

Multi-lingual support

The website now supports multiple languages, with English defined as the default.

Add an additional language

To add a new language, edit _config.yml and change languages: ["en", "ch"] to add the language code as required.

Add multi-lingual markdown

For each top-level folder, e.g. _pages, there should be a sub-directory with the matching language code, e.g. ch. Within that folder should be copies of the original English pages but translated to the appropriate language.

IMPORTANT! Pages must have lang: xx after the --- opening line, where xx is the matching language code. Without this line, the translated page may be displayed instead of the default English page.

Add multi-lingual HTML

Under _data there should be a sub-directory with the matching language code, e.g. ch. Within that folder should be - at a minimum - the file translations.yml. Each entry in that file should be translated to the appropriate language. This will then be used by HTML within the website.

If adding new HTML to the website, replace direct text with a handlebars tag like {{site.data.translations.services.form2_email}} where services.form2_email gets replaced with the appropriate tag combination from the translation file.

Netlify CMS Config

The createNetlifyCMSConfig.js Node.js script will generate the required NetlifyCMS YAML config file and output at admin/config.yml.

yarn install && node createNetlifyCMSConfig.js