This is the website for go.eco.
For developers, please follow the local set up instructions below.
For everyone else, the easiest way to make changes directly through the Github UI.
Simple updates to the website can be made directly through the github.com user interface. If you know the file that you want to edit, you can edit it by clicking the pencil icon in the file header bar. If you don't know the file that you are looking for but know the text to update, you can use the search bar in the page header to find the file you want.
Typically, you will be editing either HTML files (with a .html extension) or Markdown files (with a .md extension). If you find the need to edit a file with a different extension, please check with a developer.
- Most of the pages that you will change are in the
/sourcefolder. This folder contains the content - The overall layout for the website is stored in
/layouts.default.htmlis the layout that is currently used for all pages. Reusable sections (headers, footers, timeline, etc) are stored under/layouts/partials. - Images are stored under
/public/img/ - CSS is built using the SASS preprocessor and are stored in
/scss
Markdown is a simple markup language that can be used to provide some basic style and structure to a webpage. To see examples of how use Markdown, check out this MarkdownIT Demo. Markdown files (like this one) will render using the applied styles and structure directly in the Github interface.
When committing a change to the site, please include a meaningful comment. One sentence describing the change is sufficient. Having good comments makes it easy for us to be able to review the nature of the change at a glance without digging into the details.
The recommended approach is to prefix the comment with the area of the site being changed. Eg. champions: updated acceptance terms.
Deploying the website is taken care of by CircleCI. Every time a change is committed it will be automatically deployed to the test site: test.go.eco.
Please make sure that sure that you verify your changes on test.go.eco after committing your changes.
By default, all commits are made to the master branch. To promote changes to the production site go.eco, the master branch will need to be merged with the production branch. To do this, please follow these instructions:
- From the main screen, click on the New Pull Request button
- In the base: dropdown, choose production
- Review the changes that will be deployed by scrolling down the page. Make sure that it includes your changes and any other changes that you have verified on test.go.eco.
- Enter a comment for your commit and then
- Click on the Merge pull request button.
- Click on the Confirm merge button.
- Once your changes have been deployed by TravisCI to the production site, check out test.go.eco to verify that they have been deployed successfully.
- For OSX, install Homebrew
- Install git
brew install git(or use the GitHub Desktop client) - Install node.js
brew install node(or install directly from http://nodejs.org) - Clone the repo
git clone git@github.com:doteco/www.git - In the directory where the repo was cloned into, run
npm install - In the same directory, run
npm run build - Browse to http://localhost:8080
For CSS/SCSS, we are using stylelint to ensure that our CSS stays clean and error-free. Please run npm run stylelint before committing after making changes to the stylesheets and correct any violations you notice. There is a stylelint plugin for Sublime that helps ensure that violations are caught directly in the editor.
We are using a stylelint rule set, specified in .stylelintrc, that are based on stylelint-config-standard. We may add additional rules (property ordering, etc) as we move forward.
- Switch to production branch:
git checkout production - Ensure you have the latest:
git pull - Merge in changes from master:
git merge master git push