autonomic.zone/CONTRIBUTING.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2017-10-04 14:07:32 +00:00
# Contributing
## What Is Jekyll
2017-10-04 14:07:32 +00:00
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
2020-04-14 13:20:31 +00:00
[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.
2017-10-04 14:07:32 +00:00
[jekyll.rb]: https://jekyllrb.com/
[front matter]: https://jekyllrb.com/docs/frontmatter/
[writing posts]: https://jekyllrb.com/docs/posts/
[creating pages]: https://jekyllrb.com/docs/pages/
## Development
2017-10-04 14:07:32 +00:00
2020-05-01 08:30:31 +00:00
The prerequisites are [Docker](https://www.docker.com/) and [Docker-compose](https://docs.docker.com/compose/).
If you're on Debian, installing is easy.
Install Docker.
2017-10-04 14:07:32 +00:00
```bash
$ curl -fsSL https://get.docker.com -o get-docker.sh # have a look if you want
$ CHANNEL=stable sh get-docker.sh
2017-10-04 14:07:32 +00:00
```
2020-05-01 08:30:31 +00:00
Install Docker-compose.
```bash
$ cd autonomic.zone
$ python3 -m venv .venv
$ pip3 install -r requirements.txt
2020-05-01 08:30:31 +00:00
```
Then fire up the container with the following.
2017-10-04 14:07:32 +00:00
```bash
2020-05-01 08:30:31 +00:00
$ docker-compose up
2017-10-04 14:07:32 +00:00
```
Then visit the locally running website.
2017-10-04 14:07:32 +00:00
> http://localhost:4000
2017-10-04 14:07:32 +00:00
Then you can edit the files as normal and reload the page.
2017-10-04 14:07:32 +00:00
To stop the container when you're done, you can run:
```bash
2020-05-01 08:30:31 +00:00
$ docker-compose stop
```