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

Update documentation for releases.

Browse Source
This commit is contained in:
Luke Murphy 2017-10-04 16:07:32 +02:00
parent 99c2470a84
commit b120b6b679
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
2 changed files with 75 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,62 @@
# 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].
[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
$ rvm install 2.4.2
```
Select that version and then create an isolated [gemset](https://rvm.io/gemsets/basics) with:
```bash
$ rvm use 2.4.2
$ rvm gemset create autonomic
$ rvm gemset use autonomic
```
# Install Dependencies
Then you can get your Ruby dependencies installed with:
``` bash
$ gem install jekyll bundler
```
# Serve Website
And serve the website locally with:
``` bash
$ jekyll serve
```
# Editing Content
You can edit content in the `.md` files under `src` and `src/_posts`.
# Manage Gemset
When you're hacking later on (or in a new shell), you'll need to run:
``` bash
$ rvm use 2.4.2
$ rvm gemset use autonomic
```
And then you'll have access to the environment.

53
README.md
View File

@ -9,53 +9,26 @@ The template is based on the [spectral-jekyll-theme].
[Jekyll]: https://jekyllrb.com/
[spectral-jekyll-theme]: https://github.com/andrewbanchich/spectral-jekyll-theme
# Quick Start
# Contribute
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].
Please see [CONTRIBUTING.md] for the juicy details.
[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/
[CONTRIBUTING.md]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/master/CONTRIBUTING.md
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).
# Make A New Release
Once you've got that installed and configured, get the latest version of Ruby with:
It's easy. Just tag the current HEAD and run the Make target.
```bash
$ rvm install 2.4.2
$ git tag -a 2.0.0 $(git rev-parse HEAD)
$ git push upstream master
$ make release
```
Select that version and then create an isolated [gemset](https://rvm.io/gemsets/basics) with:
This pushes your latest tag to the upstream remote and then
takes the contents of the dist folder and pushes it to the
production branch.
```bash
$ rvm use 2.4.2
$ rvm gemset create autonomic
$ rvm gemset use autonomic
```
Our production setup makes sure to serve this new content.
Then you can get your Ruby dependencies installed with:
``` bash
$ gem install jekyll bundler
```
And serve the website locally with:
``` bash
$ jekyll serve
```
You can edit content in the `.md` files under `src` and `src/_posts`.
When you're hacking later on (or in a new shell), you'll need to run:
``` bash
$ rvm use 2.4.2
$ rvm gemset use autonomic
```
And then you'll have access to the environment.
[dist folder]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/tree/master/dist