Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2 KB

README.md

File metadata and controls

46 lines (28 loc) · 2 KB

morello-project.org website

This is the git repository for the morello-project.org static Jekyll 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.

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


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 disk space.

To build the site:

cd <git repository directory>
./build-site.sh

Note: Make sure that the website directory has rwx for the other users otherwise the command above will return an error.

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

cd <git repository directory>
JEKYLL_ACTION="serve" ./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.morello-project.org.

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

Pull Requests

When a Pull Request is created, GitHub Actions are used to automatically build a test version of the proposed modified site and then check that any links in the pages are valid.

If there are any questions or problems with the GitHub Actions, please contact Linaro IT Services.