This repository has been archived on 2023-02-03. You can view files and clone it, but cannot push or open issues or pull requests.
autonomic.zone/CONTRIBUTING.md

1.6 KiB

Contributing

What Is Jekyll

For those unfamiliar with how Jekyll works, check out jekyll.rb for all the details, or read up on the basics of front matter, writing posts and creating pages. Alternatively, just dive in and start editing! After all, the majority of this site is configuration is just flat text, so it's easy to work with.

Deploy It

  1. Push your changes to master and Dokku will try to automatically release
  2. See the Drone dashboard to see the build

Hack On It

The only prerequisite is Docker. If you're on Debian, installing is easy.

$ curl -fsSL https://get.docker.com -o get-docker.sh  # have a look if you want
$ CHANNEL=stable sh get-docker.sh

Fire up the container with the following.

$ make build  # only the first time or when changing container
$ make serve

Then visit the locally running website.

http://localhost:4000

Then you can edit the files as normal and reload the page.

To stop the container when you're done, you can run:

$ make stop

Notes

  1. For configuration, please note, we now use a dev environment config file: _config_dev.yml. Hence if you edit one _config* file and you also want that change to be reflected in the other environment ("dev", "prod") then edit the other file as well!