5
0
mirror of https://git.coop/cotech/website.git synced 2024-11-24 15:43:07 +00:00
Go to file
2019-04-25 15:50:34 +01:00
_clients Add United Diversity coop to site 2019-03-28 20:28:55 +00:00
_coops Add United Diversity address 2019-03-28 21:09:22 +00:00
_includes assets location change 2019-04-25 15:50:34 +01:00
_layouts assets location change 2019-04-25 15:50:34 +01:00
_services conneg test, see #52 2018-12-03 14:49:02 +00:00
_technologies Merge python and python-2 2019-03-28 20:54:58 +00:00
_uploads Added Devops 2017-07-05 20:57:24 +01:00
docker/web Switch to docker-compose with .htaccess support 2018-12-16 10:28:55 +00:00
images New logo for Founders and Coders 2019-04-12 08:25:30 +01:00
scripts Geocode Coop addresses to lat & long for map 2018-11-30 16:56:07 +00:00
_config.yml Link to forum instead of mailing list 2019-04-10 17:40:52 +01:00
.gitignore Put it in a docker 2018-11-30 11:56:42 +00:00
.gitlab-ci.yml Delete SSH private key from the Docker container 2019-02-15 12:44:48 +00:00
.htaccess Remove trailing whitespace for gitlab symtax highlighting 2018-12-16 12:01:01 +00:00
.ruby-version Fix ruby version to 2.5.3 2018-11-10 22:51:01 +00:00
about.md Link to forum instead of mailing list 2019-04-10 17:40:52 +01:00
docker-compose.yml Use environment variable for bundle env 2018-12-16 10:29:37 +00:00
favicon.ico Add favicon 2017-06-28 17:22:05 +01:00
Gemfile Switch to docker-compose with .htaccess support 2018-12-16 10:28:55 +00:00
Gemfile.lock Switch to docker-compose with .htaccess support 2018-12-16 10:28:55 +00:00
index.html assets location change 2019-04-25 15:50:34 +01:00
join.md Remove use of site.github.url 2018-11-29 16:20:30 +00:00
manifesto.md Remove use of site.github.url 2018-11-29 16:20:30 +00:00
README.md Improve README instructions for deploying to production 2019-04-12 10:48:49 +01:00

CoTech Website

Introduction

This is a port of the current Wordpress version of the CoTech Website to a statically-generated site using Jekyll.

Run the site locally

You can run the site on your computer as if it were live online using Jekyll. You will need git and ruby installed on your machine to do this. Then clone the repository

... using docker

Make sure you have docker (CE is fine) installed and running, and docker-compose installed, then:

git clone git@git.coop:cotech/website.git
cd website
docker-compose up -d

And visit localhost:4000 to view the site.

There are two docker volumes used here:

  • vendor - caches the ruby gems even if you recreate the containers
  • site - holds the built site files to share them with httpd (and not clutter your local filesystem)

A few useful things you might want to do:

# check the status of the containers
docker-compose ps

# stop all the containers (but don't remove them)
docker-compose stop

# stop and remove the containers (but leave the volumes)
docker-compose down

# remove everything
docker-compose down -v

# bring it back to life from any state you happen to be in
docker-compose up -d

# run some ruby/bundler commands
docker-compose run jekyll bundle --version
docker-compose run jekyll bundle update
docker-compose run jekyll bundle exec jekyll --help

... directly on your machine

Install the dependencies for the project

git clone git@git.coop:cotech/website.git
cd website
gem install bundler
bundle install

Run a local web server so that you can view the site

bundle exec jekyll server

And visit localhost:4000 to view the site.

Note: not all the images will load as there is no .htaccess support locally

Deployment

Dev/Staging

When changes are committed to the master branch the .gitlab-ci.yml file triggers the building of the site and then the copying of the results to dev.coops.tech.

Production

You need to manually deploy the changes from dev to production.

  1. View the changes on dev.coops.tech and ensure you're happy for them to be pushed to production.

  2. Visit GitLab environments. NOTE. If you don't have access to the environments page then post a message in the Website category of the CoTech forum to ask someone to do it for you.

  3. Click the "Play" icon on the right of the screen in the row for the "dev" environment and choose "deploy:production".

  4. Your changes will be visible in production when the commit listed in the "production" environment row matches the commit listed in the "dev" environment row.

Contributing

There's a list of bugs and improvements in the repository. Feel free to add more, discuss or claim any of these issues to work on.