autonomic-cooperative/autonomic.zone
Archived
5
0
Fork 0
Code Issues 15 Pull Requests 2 Releases Activity

Rinse the contributing docs and mount the dev volume
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Luke Murphy 2020-04-06 14:31:04 +02:00
parent a444219ef8
commit 8776572f3d
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
2 changed files with 13 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
CONTRIBUTING.md
View File

@ -1,8 +1,6 @@
# Contributing
> Not that these instructions may be out of date. If you find any quirks that aren't described in this file, please make patches.
# What Is Jekyll
## 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
@ -13,53 +11,27 @@ details, or read up on the basics of [front matter], [writing posts] and
[writing posts]: https://jekyllrb.com/docs/posts/
[creating pages]: https://jekyllrb.com/docs/pages/
# Using RVM to Manage Ruby
## Hack On It
In order to not blow up your computer handling a system wide Ruby installation, it is
advised that you use [RVM](https://rvm.io/rvm/install).
Once you've got that installed and configured, get the latest version of Ruby with:
The only prerequisite is [Docker](https://www.docker.com/). If you're on Debian, installing is easy.
```bash
$ rvm install 2.6.5
$ curl -fsSL https://get.docker.com -o get-docker.sh # have a look if you want
$ sh get-docker.sh
```
Select that version and then create an isolated [gemset](https://rvm.io/gemsets/basics) with:
Fire up the container with the following.
```bash
$ rvm use 2.6.5
$ rvm gemset create autonomic
$ rvm gemset use autonomic
$ make dockerserver
```
# Install Dependencies
Then visit the locally running website.
Then you can install your Ruby dependencies with:
> http://localhost:4000
```bash
$ gem install jekyll bundler
$ bundle install
```
Then you can edit the files as normal and reload the page.
# Serve Website
## Notes
And serve the website locally with:
```bash
$ make devserver
```
# Editing Content
Edit content in the `.md` files under `src` and `src/_posts`.
# Next time
When you're hacking later on (or in a new shell), you'll need to run:
```bash
$ rvm use 2.6.5
$ rvm gemset use autonomic
```
And then you'll have access to the environment.
1. For configuration, please note, we now use a `dev` environment config file: `_config_dev.yml`

1
Makefile
View File

@ -14,6 +14,7 @@ dockerserver: dockerbuild
-e JEKYLL_PORT=4000 \
-e JEKYLL_HOST=0.0.0.0 \
-e JEKYLL_CONFIG=_config_dev.yml \
-v $$(pwd):/usr/src/app \
-p 4000:4000 \
-d \
autonomic/autonomic.zone:testing