sprintDoc Demonstrator

Config-serverversion

feature_pattern
Status des Featureswichtig

Fachliche Beschreibung

  • Das Zusammenspiel zwischen einem JIRA-Projekt und einem Wiki-Bereich muss entsprechend durch einen Administrator hergestellt werden können

Technische Beschreibung

  • Konfiguration wird im JIRA vorgenommen

Konfiguration des SprintDoc-Plugins im Server-Jira

Konfiguration für ein neues Projekt:

  1. In der Projektkonfiguration die Seite Handbuch aufrufen
    1. Handbuch in Projektkonfiguration auswählen
  2. Wiki Hinzufügen
    1. Die URL des Wikis eintragen. Diese muss1) mit einem Slash / enden.
    2. Hier muss ein im Wiki existierende User angegeben werden. Aus Sicherheits und Wartungsgründen empfiehlt es sich dafür einen dezidierter API-User im Wiki zu haben
      1. Dieser Nutzer muss API-Rechte im Wiki haben. Siehe config:remoteuser
      2. Das Passwort des oben genannten Users
      3. Aus den Button Add Wiki klicken um das diese Konfiguration des Wikis zu speichern
  3. 3. Handbuch Hinzufügen
    1. Das soeben angelegte Wiki sollte bereits vorausgewählt sein. Falls es mehrere gibt, dann kann das Wiki hier ausgewählt werden.
    2. Hier muss der Namensraum für das neue Handbuch festgelegt werden. Dieser muss2) mit einen Dppelpunkt : enden. Für den Wurzelnamensraum nur den Doppelpunkt eintragen.
    3. Beliebigen Titel für das Handbuch angeben. Z.B. Projekthandbuch/Produkthandbuch/Nutzerhandbuch/Lessons Learned
    4. Zum Speichern auf den Button Add Handbook klicken

Zugehörige Requirements

Nichts gefunden
1)
FIXME oder kann?
2)
FIXME: recherchieren ob muss oder kann. c.f. SPR-346