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
Luke Murphy 558b71934d
All checks were successful
continuous-integration/drone/push Build is passing
Add notes on bump
2020-05-02 18:35:50 +02:00

2.1 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.

Development

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

Production

Bump the tag in .drone.yml and docker-compose.production.yml.

Here's an example git diff. Please update the change log too.

+++ b/.drone.yml
@@ -10,7 +10,7 @@ steps:
       password:
         from_secret: docker_reg_passwd
       repo: decentral1se/autonomic.zone
-      tags: v2.0.0
+      tags: v3.0.0

   - name: deployment
     image: decentral1se/drone-stack:19.03.8-override-compose

+++ b/docker-compose.production.yml
@@ -3,7 +3,7 @@ version: "3.7"

 services:
   jekyll:
-    image: decentral1se/autonomic.zone:v2.0.0
+    image: decentral1se/autonomic.zone:v3.0.0
     command: jekyll serve --host 0.0.0.0 --trace
     environment:
       JEKYLL_ENV: production

Our drone.autonomic.zone configuration automatically deploys.