Web Sites

There are currently three web sites relating to OpenSeizureDetector:

openseizuredetector.org.uk - the original project web site.
openseizuredetector.github.io - this web site, which will replace the original.
osdapi.ddns.net - Simple user registration site for the Data Sharing system.

The struture of each is described below

OpenSeizureDetector.gitub.io

This is web site is intended to be the replacement for the current rather random site at OpenSeizureDetector.org.uk. It uses the Jekyl static site generation tool and its source files are stored on github in the openseizuredetector.github.io repository. This means it should be easier for users to suggest changes to the site and implement them using pull requests, compared to using wordpress.

The site is hosted on github pages at openseizuredetector.github.io.

One unresolved issue with this approach is how to handle translations.

Structure

The top level index.md is the home page
The pages-about folder contains pages describing the background and goals of the project
The pages-user folder contains user installation and troubleshooting instructions.
The pages-developer folder contains information for developers to guide them through the structure of the project and the various github repositories containing code for it.
The assets/images folder is used to store images
The _data/navigation.yml file is used to specify the items in the menu at the top of the page.

Contributing Changes

Goto the github repository page: openseizuredetector.github.io.
Click on the ‘Fork’ button to create your own copy of the repository.
Make the desired changes, either by checking out the repository to your local machine, or usin the github online editor, then commit your changes to your github copy of the repository.
In your github repository, press the ‘Pull Requests’ button, followed by the ‘New pull request’ button.
Review the changes that will be included, then press the ‘Create pull request’ button at the bottom of the page.
We will then review your proposal and get in touch if we think any changes are appropriate before including them.

Credits

OsdApi.ddns.net

This site provides user registration utilities and the API for the Data Sharing system which is used to produce the Open Seizure Database. It is a Django based system which runs on a small virtual server. The source code is stored on github in the WebAPI repository.

OpenSeizureDetector.org.uk

The curent main web site uses Wordpress - static pages are stored as wordpress ‘pages’ and news items are stored as ‘posts’.

There is a Polish version of the installation instructions.