Button zur Bearbeitung einer Seite

Feature Template

Detailed description

Es soll die Möglichkeit geben, einen "Seite bearbeiten"-Button am Ende einer Seite anzuzeigen. Dieser führt User direkt in den Bearbeitungsmodus im entsprechenden Versionierungssystem. Siehe https://docs.fitko.de/fit/policies/

Justification of the request

Dadurch werden User ermutigt, Änderungsvorschläge vorzunehmen. Gerade bei kleineren/offenen Projekten ist dies häufig gewünscht. Zudem können technisch-versierte User die Versionierung des Versionierungssystem nutzen, um ältere Versionen einzusehen bzw. über das System weitere Informationen über das Projekt erhalten.

Proposed implementation (optional)

• Definition in _meta.json

{
  ...
  edit: {
    "enabled": true,
    "icon": "auto",  // auto, edit, github, opencode, gitlab oder Pfad zum Icon
    "label": "Diese Seite bearbeiten", // default label overwrite
    "link": "https://gitlab.opencode.de/mein-projekt/${docPath}/", // ${docPath} wird durch Pfad zum Dokument ersetzt
  }
}

"icon": "auto" versucht, das verwendete Versionierungssystem aus dem angegebenen Link zu parsen und das passende Icon anzuzeigen (Fallback: edit (Stift-Icon)). Der Automatismus kann durch die Eingabe eines Standard-Keywords oder Icon-Pfades überschrieben werden.