Rinse the contributing docs and mount the dev volume
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
a444219ef8
commit
8776572f3d
@ -1,8 +1,6 @@
|
|||||||
# Contributing
|
# 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
|
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
|
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/
|
[writing posts]: https://jekyllrb.com/docs/posts/
|
||||||
[creating pages]: https://jekyllrb.com/docs/pages/
|
[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
|
The only prerequisite is [Docker](https://www.docker.com/). If you're on Debian, installing is easy.
|
||||||
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:
|
|
||||||
|
|
||||||
```bash
|
```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
|
```bash
|
||||||
$ rvm use 2.6.5
|
$ make dockerserver
|
||||||
$ rvm gemset create autonomic
|
|
||||||
$ rvm gemset use autonomic
|
|
||||||
```
|
```
|
||||||
|
|
||||||
# Install Dependencies
|
Then visit the locally running website.
|
||||||
|
|
||||||
Then you can install your Ruby dependencies with:
|
> http://localhost:4000
|
||||||
|
|
||||||
```bash
|
Then you can edit the files as normal and reload the page.
|
||||||
$ gem install jekyll bundler
|
|
||||||
$ bundle install
|
|
||||||
```
|
|
||||||
|
|
||||||
# Serve Website
|
## Notes
|
||||||
|
|
||||||
And serve the website locally with:
|
1. For configuration, please note, we now use a `dev` environment config file: `_config_dev.yml`
|
||||||
|
|
||||||
```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
Makefile
1
Makefile
@ -14,6 +14,7 @@ dockerserver: dockerbuild
|
|||||||
-e JEKYLL_PORT=4000 \
|
-e JEKYLL_PORT=4000 \
|
||||||
-e JEKYLL_HOST=0.0.0.0 \
|
-e JEKYLL_HOST=0.0.0.0 \
|
||||||
-e JEKYLL_CONFIG=_config_dev.yml \
|
-e JEKYLL_CONFIG=_config_dev.yml \
|
||||||
|
-v $$(pwd):/usr/src/app \
|
||||||
-p 4000:4000 \
|
-p 4000:4000 \
|
||||||
-d \
|
-d \
|
||||||
autonomic/autonomic.zone:testing
|
autonomic/autonomic.zone:testing
|
||||||
|
Reference in New Issue
Block a user