Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

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

To contribute changes, please refer to FAQs regarding Developer documentation.

Software requirements

Local development requires 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 2.7.5

Then do:

bundle config set --local path 'vendor/bundle'
bundle install

Occasionally a site maintainer will have updated dependencies, and there will be changes to the Gemfile.lock file. Do bundle install again.

Docker

Instead of installing the requirements you may run

docker-compose up

to use the Jekyll Docker image.

Our Gemfile defines the version of Jekyll that we use.

Local development

To view and edit documents on your local machine, run the local Jekyll server:

bundle exec jekyll serve --port 5000

Then visit localhost:5000 with the browser, and proceed to the page of interest.

Edit the relevant Markdown source document, and save it. The server will automatically re-generate that particular page. Now refresh the web browser to view its changes.

When finally ready with your set of changes, commit and push the branch to GitHub. See deployment notes below.

Link checker

To verify internal and external links, do:

rake proof

or

bin/htmlproofer.sh

This will re-generate the whole site, then report any broken links.

Note that verification of GitHub links is disabled.

Work area - management of dev site

See notes about the operation and management. (Despite the name of this repository, it is not built using the GitHub tools.)

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 to view the generated branch site.

Additional information

Refer to FAQs regarding Developer documentation and Raising Jira tickets.

The FOLIO Slack channel #dev-website