This repository contains resources for the EHDEN Academy (https://academy.ehden.eu).
The EHDEN Academy is an e-learning environment that is being developed by the European Health Data and Evidence Network (EHDEN) project (www.ehden.eu). Its aim is to train all stakeholders in the project in the use of the tools and processes that are being adopted in EHDEN. Course development on the OMOP Common Data Model and the rich set of tools developed in the Observational Health Data Sciences and Informatics (OHDSI) project are developed in collaboration with that community (See www.ohdsi.org for more information).
Documentations for developers can be found at Academy Docs. To modify the documentation, edit the markdown files (*.md) inside the /docs/ and /docs/pages/ directory of this repository.
/docs/ directory:
- index.md (created https://ehden.github.io/Academy/)
- about.md (creates https://ehden.github.io/Academy/about/)
/docs/pages/ directory:
- (all other pages).md (e.g. https://ehden.github.io/Academy/pages/screen-capture.html)
The markdown files can be edited using the Markdown syntax, which is automatically compiled into an HTML website once changes are commited to this repository.
Every page that is newly added to the /docs/pages/ directory requires a header to allow formatting. For example, the notice the header in the Course Development markdown file.
---
layout: "page"
nav_order: 2
title: "Course Development"
has_children: true
---
The header consists of the following key-value pairs:
- layout should always have value "page"
- nav_order is used for ordering the pages, thus, need to be consistent across all pages
- title is a unique display name, which is also used as identifier for that page
- has_children indicates whether the page is a parent page
A parent can have one or multiple child pages, e.g. the child page generated from the Screen Capture markdown file has the following header.
---
layout: "page"
nav_order: 3
title: "Screen Capture"
parent: "Course Development"
---
It is important to provide the parent key with the correct value, which is the title of the parent page, in this care "Course Development" as spelled above.
To edit a page simply click the "Edit this file" icon, which will open a file editor.
Commiting the changes will automatically compile the updated documentation.
The EHDEN Academy is being developed in Moodle and is hosted in the Amazon AWS cloud.
Please report issues and suggestions through the GitHub issue tracker