Wichtiger Bestandteil eines Open-Source-Projektes ist die Dokumentation. An dieser Stelle werden die technische Basis vorgestellt, Konzepte und Regeln festgelegt sowie Hilfestellungen für die dokumentierenden Entwickler gesammelt.
Die Dokumentation von MyCoRe und die Unterstützung der Entwickler erfolgt über mehrere Medien.
Im Frühjahr 2019 wurde die Dokumentation von Apache Forrest auf den Static Site Generator Hugo umgestellt.
Die Installation und die ersten Schritte werden im Abschnitt Einrichtung beschrieben.
Die Verzeichnisstruktur folgt den Empfehlungen von Hugo (s. Hugo: Directory Structure).
de
, en
) wurde ein eigener Ordner erstellt
(s. Hugo: Translation by content directory).
Unter dem Sprachcode io
können Textentwürfe abgelegt werden. Diese können in der lokalen Hugo-Instanz gesehen und bearbeitet werden.
Auf dem Server werden sie ausgeblendet.mycore-bootstrap
) entspricht der Struktur des Hauptverzeichnisses.Der Content wird in 3 Bereiche gegliedert. Dadurch können für diese verschiedene Templates und Layouts definiert werden.
---
title: "Dokumentation zur MyCoRe Dokumentation"
description: "Wichtiger Bestandteil eines Open-Source-Projektes ist die Dokumentation.
An dieser Stelle werden die technische Basis vorgestellt, Konzepte und Regeln festgelegt
sowie Hilfestellungen für die dokumentierenden Entwickler gesammelt."
author: ['Jens Kupferschmidt', 'Kathleen Neumann', 'Robert Stephan']
mcr_version: ['2018.06']
date: "2019-04-04"
---
<h2>Technische Basis: Hugo</h2>
<p>Im Frühjahr 2019 ... </p>
Headerbereich dieser Seite
Der Header (s. Hugo: Front Matter) wird in YAML-Syntax beschrieben und enthält folgende Properties:
<h1>
-Überschrift auf der Webseite angezeigt.Für Blog- und News-Seiten gilt ein erweiterter Header. Dieser wird im Abschnitt News und Blog erläutert.