NEMI Documentation

This is the official repository for the documentation of the NEMI project that is intended for public consumption. The contents of this repository are organized in the form of Wiki chapters and written in the Markdown format. The chapters are located under the root folder and follows the GitLab Wiki folder structure. The HTML documentation generated from this repository is deployed to the NEMI project website.

This repository is configured as a Wiki repository to ease the daily development and documentation activities. Before contributing / editing this Wiki, kindly read through the the CONTRIBUTIONS guide.

The documentation is released under NEMI Docs: https://docs.project-nemi.org

For information regarding the NEMI project, please visit the NEMI Website.

List of Chapters

The current list of chapters is visible in the sidebar of the Wiki

[[TOC]]

Getting Started

These instructions will get you a copy of this repository on your local machine ready for your contributions.

Prerequisites

A GitLab account, configured with your SSH keys

NOTE: Wiki Repositories can be cloned ONLY over SSH.

Install

Just clone this Wiki repository to your favourite location. No further installations steps are necessary for this repository.

    // clone over SSH
    $ git clone git@gitlab.fokus.fraunhofer.de:nemi/documentation.wiki.git
    $ cd documentation.wiki

Deployment

All changes to the master branch are deployed to the NEMI website automatically with Gitlab CI/CD. No manual user operation is needed. The nemi/infrastructure is responsible for the release and deployment of the documentation.

Built With

Pandoc - Universal document converter

Contributing

Its imperative that you read through the CONTRIBUTING notes before attempting to edit / add new content to the Wiki.

Authors

Alexander Willner - Fraunhofer FOKUS/NGNI
Arun Prakash - Fraunhofer FOKUS/SQC

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Docs