Jekyll hosted websites

A number of OME websites are produced using Jekyll, including:

These sites can be built and tested by installing a local copy of Jekyll. The Help and Figure sites are also built by CI jobs, see Documentation jobs.

The publicly released pages are hosted and automatically generated by GitHub Pages with a custom subdomain.

Installing Jekyll

Jekyll can be installed as a system application (requires administrator privileges) or for a single user.

  1. Install a recent version of Ruby. Recent versions of OS X and Linux may already include a suitable version, however you will require administrator privileges to install Jekyll. Alternatively on OS X you can use Homebrew, and on Linux either rbenv or RVM:

    brew install ruby
    
  2. Install Jekyll:

    gem install jekyll
    

Running Jekyll

In a terminal enter the local git checkout and run:

jekyll serve -w -b ''

This will build the web pages and start a local server on http://localhost:4000/. Jekyll should automatically rebuild the pages when changes are made to the source files, and will override any baseurl defined in _config.yml.

Editing the websites

Main OME Website

The source for www.openmicroscopy.org is on GitHub at https://github.com/openmicroscopy/www.openmicroscopy.org. The website uses the ‘master’ branch, PRs should be opened directly against it. Most of the files are written in html but the announcements posts are in markdown and further content may migrate to markdown in future.

Once a PR is open and has passed Travis, you can build the staging site for review by triggering the WWW-merge job. The site will be viewable at https://snoopycrimecop.github.io/www.openmicroscopy.org/.

Once the PR is merged, the live site can currently only be updated by one of the sysadmin team running a playbook to update the deployment.

OME Blog

The source for blog.openmicroscopy.org is at https://github.com/ome/blog. The website uses the ‘gh-pages’ branch and as there is no merge build or staging page, you should open a PR directly against this branch. The files are written in markdown. Branches must be built locally for review and merging PRs automatically updates the live site.

Help site

help.openmicroscopy.org covers OMERO user guides illustrated with screenshots and also an introduction for facility managers aimed at signposting them to parts of the sysadmin docs without burying them in technical details from the start. Increasingly these are supplemented with video content and moving forward movies and training presentations may become the default format for new workflows.

The source is at https://github.com/openmicroscopy/ome-help/. The website uses the ‘gh-pages’ branch for the live deployment but PRs should be opened against ‘master’ for review. All the files are currently written in html.

Once a PR is open against the ‘master’ branch and has passed Travis, you can build the staging site for review by triggering the OME-help-staging job. The site will be viewable at http://help.staging.openmicroscopy.org.

Once the PR is merged, running the OME-help-release build will open a PR to transfer the content to the ‘gh-pages’ branch. Once that PR is merged, the live site will be updated automatically.

Figure website

http://figure.openmicroscopy.org/ is now mostly a legacy site from before OMERO.figure was considered a core part of the project. It will likely be merged into the main website in the future but for now it hosts a live demo, installation instructions, release announcements and other OMERO.figure related blog posts.

The source is at https://github.com/ome/omero-figure/. The live website uses the ‘gh-pages’ branch but PRs should be opened against ‘gh-pages-staging’ for review. Most of the content is written in markdown.

Once a PR is open against the ‘gh-pages-staging’ branch, you can build the staging site for review by triggering the FIGURE-help-staging job. The site will be viewable at http://figure.staging.openmicroscopy.org.

Once the PR is merged, running the FIGURE-help-release build will open a PR to transfer the content to the ‘gh-pages’ branch. Once that PR is merged, the live site will be updated automatically.