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

66 lines
1.5 KiB
Markdown
Raw Normal View History

2017-10-04 14:07:32 +00:00
# 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.
2017-10-04 14:07:32 +00:00
# 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].
[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/
# Using RVM to Manage Ruby
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:
```bash
2019-11-14 14:07:17 +00:00
$ rvm install 2.6.5
2017-10-04 14:07:32 +00:00
```
Select that version and then create an isolated [gemset](https://rvm.io/gemsets/basics) with:
```bash
2019-11-14 14:07:17 +00:00
$ rvm use 2.6.5
2017-10-04 14:07:32 +00:00
$ rvm gemset create autonomic
$ rvm gemset use autonomic
```
# Install Dependencies
Then you can install your Ruby dependencies with:
2017-10-04 14:07:32 +00:00
``` bash
$ gem install jekyll bundler
2019-08-31 20:35:07 +00:00
$ bundle install
2017-10-04 14:07:32 +00:00
```
# Serve Website
And serve the website locally with:
``` bash
$ make devserver
2017-10-04 14:07:32 +00:00
```
# Editing Content
Edit content in the `.md` files under `src` and `src/_posts`.
2017-10-04 14:07:32 +00:00
# Next time
2017-10-04 14:07:32 +00:00
When you're hacking later on (or in a new shell), you'll need to run:
``` bash
2019-11-14 14:07:17 +00:00
$ rvm use 2.6.5
2017-10-04 14:07:32 +00:00
$ rvm gemset use autonomic
```
And then you'll have access to the environment.