autonomic.zone/CONTRIBUTING.md

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

Just push your changes to master and it will be deploy. See Drone for more.

Hack On It

The prerequisites are Docker and Docker-compose.

If you're on Debian, installing is easy.

Install Docker.

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

Install Docker-compose.

$ cd autonomic.zone
$ python3 -m venv .venv
$ pip install -r requirements.txt

Then fire up the container with the following.

$ docker-compose up

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:

$ docker-compose 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!