Update documentation for releases.
This commit is contained in:
parent
99c2470a84
commit
b120b6b679
62
CONTRIBUTING.md
Normal file
62
CONTRIBUTING.md
Normal 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
53
README.md
@ -9,53 +9,26 @@ The template is based on the [spectral-jekyll-theme].
|
|||||||
[Jekyll]: https://jekyllrb.com/
|
[Jekyll]: https://jekyllrb.com/
|
||||||
[spectral-jekyll-theme]: https://github.com/andrewbanchich/spectral-jekyll-theme
|
[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
|
Please see [CONTRIBUTING.md] for the juicy details.
|
||||||
details, or read up on the basics of [front matter], [writing posts] and
|
|
||||||
[creating pages].
|
|
||||||
|
|
||||||
[jekyll.rb]: https://jekyllrb.com/
|
[CONTRIBUTING.md]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/blob/master/CONTRIBUTING.md
|
||||||
[front matter]: https://jekyllrb.com/docs/frontmatter/
|
|
||||||
[writing posts]: https://jekyllrb.com/docs/posts/
|
|
||||||
[creating pages]: https://jekyllrb.com/docs/pages/
|
|
||||||
|
|
||||||
In order to not blow up your computer handling a system wide Ruby installation, it is
|
# Make A New Release
|
||||||
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:
|
It's easy. Just tag the current HEAD and run the Make target.
|
||||||
|
|
||||||
```bash
|
```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
|
Our production setup makes sure to serve this new content.
|
||||||
$ rvm use 2.4.2
|
|
||||||
$ rvm gemset create autonomic
|
|
||||||
$ rvm gemset use autonomic
|
|
||||||
```
|
|
||||||
|
|
||||||
Then you can get your Ruby dependencies installed with:
|
[dist folder]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/tree/master/dist
|
||||||
|
|
||||||
``` 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.
|
|
||||||
|
Reference in New Issue
Block a user