Our public website

Visit us at nodoambiental.org.
(in Spanish)

---

What is this?

Hi! This is the repo for the current version of our website. There's a future version under development, but it will be a long way until we get there.

It is deployed as a static site, oriented towards optimizing load times, promoting our brand and acting as a welcome site for everyone to know better who we are and what we do.

Why like this?

This site is built this way so all the data and page construction can be offloaded to an easier to manage structure for non-coders. Currently, most of the global website data lies in a bunch of YAML files, and the posts themselves are a bunch of markdown.

This way, the less technical members of our development group can manage the website without much hassle, but allowing it to be kept simple and headless. The next version will include a CMS so the whole of our editorial group can manage the site themselves.

Building the site

You will need ruby and bundler.

The site won't compile on any kind of current ruby version, only in 2.5.1p57, and in line with that, some dependencies are quite broken, so please respect the present Gemfile.lock.

Build

1. Clone this repo

   git clone https://github.com/nodoambiental/website

2. Install dependencies

   bundle install

3. Build

   bundle exec jekyll build

Ruby version management

For managing the ruby and gems versions you will need rbenv, rbenv-gemset, and rbenv-bundler.

So if you don't have any rvm installed, you will need to:

1. Install rbenv according to your OS/distro

2. Install rbenv-gemset

   git clone git://github.com/jf/rbenv-gemset.git $HOME/.rbenv/plugins/rbenv-gemset

3. Install rbenv-bundler

   git clone git://github.com/carsomyr/rbenv-bundler.git $HOME/.rbenv/plugins/bundler

4. Install the correct ruby version

   rbenv install 2.5.1

5. Create the correct gemset

   rbenv gemset create 2.5.1 website

6. Activate the needed ruby version

   rbenv global 2.5.1

7. cd into the repo root and install the correct bundler

   rbenv rehash
   gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)"

   See this about the weird bundle install command.

8. Restore the system ruby version

   rbenv global system

Then you can proceed normally.

Remember this commands only work for Bash, so use it or search how to correctly enable rbenv for your shell and modify the bundle installation command in step seven.

Roadmap

In no particular order.

---

• Get docs up to standard

  • Rewrite README
  • Add structure specs to every folder
  • Add docs/ and dump stuff there
  • Add CONTRIBUTING
  • Document hooks and extra build/deploy steps
  • Document bugs, quirks and upcoming features
  • Document JS and Liquid templates

• Ditch Jekyll and add Bazel as a build system

  • Manage to get a working build server
  • Write general structure and required files
  • Add rules for Markdown
  • Add rules for Liquid
  • Add rules for bibliography
  • Add rules for navigation
  • Add rules for site structure / posts
  • Wrap up

• Cleanup site

  • Remove mainteinance banner
  • Clean structure
  • Fix obvious bugs

• Add localization

  • Translate Readme
  • Translate structure specs
  • Translate docs/
  • Translate comments in source
  • Translate posts
  • Replace string literals for enums
  • Modify folder structure to allow for localization
  • Add localization strings files
  • Integrate with a crowdlating service

• Add proper CI/CD

  • Fix Drone
  • Get CircleCI working

• Reach feature parity between master and development branches

  • Fix styles
  • Fix build system
  • Fix bibliography changes
  • Reach parity itself

• Meta

  • Cleanup GH repo
  • Add helping bots/apps
  • Put everything in the correct issues
  • Get up to standards
  • Write issue template
  • Set contributing guidelines
  • Enforce transparency and all relevant checks