The deliveroo.engineering blog is the Deliveroo Engineering team’s presence on the web. It is hosted using Github Pages, which runs on Jekyll. The main bits of the blog are built using Liquid and SCSS. Content written for the site is formatted with Markdown.
If you’re doing any work on any part of the deliveroo.engineering blog, the
best way to test it is to run it locally:
- Install docker
$ git clone git@github.com:deliveroo/deliveroo.engineering.git$ cd deliveroo.engineering$ make build$ make run- Open
http://localhost:4000in your browser
Jekyll will then generate the site files automatically for you, which usually takes no more than a couple of seconds each time you make a change.
We love it when our engineers are able to share the lessons of their experiences with the world (and each other!). If you have anything you’d like to write about which has relevance to the world of engineering, it'd be great to hear it!
First, check out the internal documentation on writing blog posts.
Then, once the post is ready to go:
- Name your branch
blog-posts/name-of-your-post. - Look at the [blog post template][template] to get an idea on how to structure your post.
- If you’ve not written a blog post before, create an author bio page using the [bio template][template] as a template, and add a square photo of yourself to the portraits folder. Ideally this should be a JPEG of at least 600px square.
- Test your blog post locally to ensure it looks okay.
- Create a pull request and tag it with
ready for editor review. - Invite feedback from the Engineering team!
- Request review from the Engineering Editorial team!
If you’re submitting a general improvement or bugfix to the blog website itself,
follow standard process by opening a pull request, and tagging the issue
appropriately with bugfix, design, refactor etc.