Project

General

Profile

Feature #3657

QFQ Dokumentation

Added by Carsten Rose over 3 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Target version:
Start date:
01.05.2017
Due date:
% Done:

100%

Estimated time:
Discuss:

Description

Die Doku muss nach Installation der QFQ Extension im T3 BE lesbar sein.

Associated revisions

Revision 23bbe1f1 (diff)
Added by Carsten Rose about 2 years ago

  • Add some notes on how to create T3 Doc for QFQ.
  • Update 'Makefile' to automatically trigger the external Sphinx rednering process.

History

#1 Updated by Carsten Rose over 3 years ago

To: documentation@typo3.org
From: Carsten Rose <support@math.uzh.ch>
Subject: ask for a T3DocumentationStarter project.
Message-ID: <b74c41ba-a013-736e-d53b-ea07069fc644@math.uzh.ch>
Date: Mon, 1 May 2017 11:27:18 +0200

Hi there

github user name: math-uzh

thanks

Carsten

#2 Updated by Carsten Rose over 3 years ago

Dear Carsten Rose,

Thank you for your mail.

Done. Here you go: https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/

Don't forget to log in into Github and accept the invitation for collaboration. You should have received an email as well that is inviting you.

Best regards,
Martin Bless

#3 Updated by Carsten Rose over 3 years ago

  • % Done changed from 60 to 50
  • Das Github Projekt ausgescheckt under `~crose/PhpProjects/qfq-doc`
  • D.h. es ist aktuell ausserhalb git.math.uzh.ch. Damit sind aktuell zwei PhpStorm Projekte noetig.
  • CR ist nicht klar warum die lokalen Dokumente in der QFQ Extension nun besser funktionieren sollten.
  • Der doc github master branch laeuft in der aktuellen Variante ganz sicher out of sync mit den aktuellen QFQ Versionen. SCHLECHT

#4 Updated by Carsten Rose over 3 years ago

  • % Done changed from 100 to 80
Status Quo:
  • Die Dokumentation wird im Hauptprojekt 'qfq' gepflegt und bearbeitet.
  • Beim committen gibt es auf Jenkins einen Build Taks, der die reST Dokumente zu HTML rendert und beim bauen des ZIPs (=QFQ Extension zum installieren) mit in das ZIP kopiert.
Deploy:
  • https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/
  • Projekt Public-Info-053 liegt auf github (User: math-uzh)
  • CR hat das Projekt lokal im Order `~crose/PhpStorm-Projects/qfq-doc` ausgecheckt.
  • Im QFQ Makefile gibt es die Regel 'update-qfq-doc': diese kopiert alle Doku reST Files vom Projekt 'qfq' nach 'qfg-doc'.
  • CR muss im Verzeichnis 'qfq-doc' manuell ein 'git commit' und 'git push' aufrufen. Das sollte nur bei Versionen die im Typo3 TER erscheinen gemacht werden.

#5 Updated by Carsten Rose over 3 years ago

Anfrage wie lokal dokumentieren: https://forum.typo3.org/index.php/t/216000/

#6 Updated by Carsten Rose about 3 years ago

  • Target version set to next4

#7 Updated by Carsten Rose about 3 years ago

  • Tracker changed from Support to Feature

#8 Updated by Carsten Rose over 2 years ago

  • Status changed from In Progress to Closed

#9 Updated by Carsten Rose about 2 years ago

Im QFQ Makefile wird neu nach dem einchecken in das github Projekt der Trigger ausgeloest zum rendern:

https://docs.typo3.org/~mbless/github.com/T3DocumentationStarter/Public-Info-053.git.make/request_rebuild.php

#10 Updated by Carsten Rose about 2 years ago

  • Target version changed from next4 to 18.9.2

Also available in: Atom PDF