sprudeel/docu

PBS MiData Documentation Platform

This repository contains the source code of the documentation platform available at https://scout-ch.github.io/docu/. The documentation platform is ment to spread available documentation of the member database of PBS called MiData.

Structure

Header Menu

• Entrance: Introductory videos for the different MiData roles. This is ment to give the users a quick and catchy introduction to the MiData application. The interest in the MiData should be awakened here.
• Documentation: The actual documentation containing articles grouped into meaningful categories. It is indicated for each article for which users its content is particularly interesting.
• FAQ: Often used MiData features listed as a FAQ.
• Release Notes: Release notes of the different releases grouped by its minor releases.

Footer Menu

• Contact: Link to the contact page of https://pfadi.swiss
• Submit docu article: Information on how to contribute to the documentation platform
• Impressum: Link to the imprint page of https://pfadi.swiss
• MiData: Link to the member database of PBS called MiData at https://db.scout.ch

Content contribution

The PBS MiData Documentation Platform is meant to be changed by you! If you see something that bothers you or if you miss an information in the documentation feel free to change it yourself! Everything you need to know for submitting your changes can be red in the Contributing file.

Code contribution

To develop the documentation platform set up a Jekyll development environment on your computer. Take a look at the official docs of Jekyll.

To run the Jekyll code locally use the command bundle exec jekyll serve The command sets up a local testing server. The web page is available afterwards on the localhost on port 4000.

Please checkout a fork of this repository and apply your changes. Contribute your changes to the project by creating a pull request. Your code contributions will usually be accepted quickly.