Website for FOLIO open source development
CSS HTML Python JavaScript Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data Add mod-orders FOLIO-903 Aug 16, 2018
_faqs Merge branch 'master' into FOLIO-1390-doc-naming-conventions Aug 16, 2018
_includes Reduce spacing above tocbot js-toc-wrapper Jun 19, 2018
_layouts Include JS and init tocbot Jan 3, 2018
_posts Now use https for dev links FOLIO-832 Feb 14, 2018
_sass Enable building of docs for shared repos FOLIO-903 Jul 23, 2018
about Fix Lokalise logo width Apr 26, 2018
assets Adjust dev.folio.org theme config for projectwide navbar Jun 16, 2018
bin Ignore internal "#" links in projectwide-navbar May 17, 2018
community Link presentation preparation materials Aug 16, 2018
doc Reduce doc/index Apr 1, 2018
download Move other guides docs Apr 1, 2018
faqs The FAQs are in Guides section Apr 2, 2018
guidelines Add basic link jsonapi Aug 15, 2018
guides Merge branch 'master' into FOLIO-1390-doc-naming-conventions Aug 16, 2018
images Add Lokalise to Thanks page Apr 26, 2018
reference Add glossary ERM Aug 16, 2018
source-code Update list of repositories FOLIO-359 Aug 16, 2018
start Add section "Getting help and helping" Jul 25, 2018
tutorials Fix link to FOLIO-1348 update tutorial Jul 17, 2018
work Move notes to work/maintain-theme.md May 17, 2018
.editorconfig Handle Python indent_size FOLIO-351 Dec 8, 2017
.gitattributes Prevent Linguist language classification Ruby Mar 26, 2017
.gitignore Add bin/htmlproofer.sh FOLIO-837 Sep 18, 2017
CNAME Fix remaining whitespace Sep 29, 2016
CONTRIBUTING.md Add note on contributing changes Jun 27, 2016
Gemfile Downgrade jekyll-remote-theme FOLIO-1284 Jun 12, 2018
Gemfile.lock Downgrade jekyll-remote-theme FOLIO-1284 Jun 12, 2018
README.md Move notes to work/maintain-theme.md May 17, 2018
_config.yml Set site title plural Developers Jun 19, 2018
banner-area.md Add copy of banner-area.html cjt-v2 Dec 16, 2017
buildspec.yml Use s3api to update website bucket config Dec 22, 2017
docker-compose.yml Add docker-compose.yml. Apr 30, 2018
error.md Add error document Dec 22, 2017
feed.xml First commit Jun 16, 2016
index.md Improve links to getting started Jul 25, 2018
s3-website-config.json Redirect troubleshooting Apr 16, 2018
search-other.md Prepend leader text to page title FOLIO-1058 Feb 8, 2018
search.md Use autofocus for search input Apr 14, 2018
search_data.json Remove trailing spaces FOLIO-351 Jul 17, 2018

README.md

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