Permalink
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (43 sloc) 1.56 KB

This is the source for "FOLIO Developers" at dev.folio.org

To contribute changes, please make the changes in a new branch and submit a pull request.

Software requirements

Local development requires curl and Ruby and Bundler. The 'bundle install' step will install the relevant local Jekyll.

For Ruby, using rbenv and its 'ruby-build' plugin ensures a smooth process. In this directory, set the ruby version with: rbenv local <version>

Then do:

bundle install --path vendor/bundle
bundle exec jekyll serve --port 5000
bundle exec jekyll build

Occasionally do bundle update to advance the versions of dependencies.

Docker

Instead of installing the requirements you may run

docker-compose up

to use the Jekyll Docker image.

Link checker

To verify internal and external links, do:

./bin/htmlproofer.sh

Work area - management of dev site

See notes.

Deployment

The master branch is automatically deployed as dev.folio.org

Other branches are re-built upon push of changes. Follow the GitHub link from the branch's continuous-integration details.

Additional information

See project FOLIO at the FOLIO issue tracker. We use the label "devweb".

The FOLIO Slack channel #dev-website