Documentation for the IPF project
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github initial commit Nov 21, 2018
_data Add development page to navigation Nov 21, 2018
_includes initial commit Nov 21, 2018
_layouts initial commit Nov 21, 2018
_pages initial commit Nov 21, 2018
_sass initial commit Nov 21, 2018
_src initial commit Nov 21, 2018
assets initial commit Nov 21, 2018
docs initial commit Nov 21, 2018
test initial commit Nov 21, 2018
.gitignore initial commit Nov 21, 2018
.travis.yml initial commit Nov 21, 2018
CHANGELOG.md initial commit Nov 21, 2018
Gemfile initial commit Nov 21, 2018
LICENSE initial commit Nov 21, 2018
README-minimal-mistakes.md initial commit Nov 21, 2018
README.md initial commit Nov 21, 2018
Rakefile initial commit Nov 21, 2018
_config.yml initial commit Nov 21, 2018
banner.js initial commit Nov 21, 2018
index.html initial commit Nov 21, 2018
minimal-mistakes-jekyll.gemspec initial commit Nov 21, 2018
package.json initial commit Nov 21, 2018
staticman.yml initial commit Nov 21, 2018

README.md

IPF Documentation BETA

This is a GitHub Pages project documenting the eHealth Integration Platform (IPF). The documentation is deployed on github at this location. The current (official) documentation can still be found here.

The layout is based on the Minimal Mistakes Theme (see description in README-minimal-mistakes.md).

Why?

The current documentation is difficult and time-consuming to build using Maven's site generator. The underlying theme is not developed any further and does not work properly with newer versions of the site plugin.

Build remotely

There is nothing to be gone. GitHub Pages are automatically rebuilt and redeployed after a commit. Make sure, however, that remote_theme property is enabled the theme property is disabled in _config.yml.

Build locally

In order to build and work locally,

  • Follow these instructions. Hint: install/download the required ruby gems and jekyll plugin without using a proxy!
  • For local site generation, comment out the remote_theme and enable the theme property in _config.yml.
  • Run bundle exec jekyll serve
  • The site is served on http://localhost:4000/ipf-docs

TO-DOs

  • Javadocs not included yet
  • Decide whether other Maven site reports shall be included here (I don't think so)
  • Add description here on how/where to add or edit pages
  • Add description on how to update the theme
  • Links missing, some polishing