From b120b6b679a865ff318709c8746867719faca6f7 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Wed, 4 Oct 2017 16:07:32 +0200 Subject: [PATCH] Update documentation for releases. --- CONTRIBUTING.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 53 +++++++++++------------------------------- 2 files changed, 75 insertions(+), 40 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f715455 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index d3e1f3a..7d856a3 100644 --- a/README.md +++ b/README.md @@ -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