Actions
Feature #3657
closedQFQ Dokumentation
Start date:
01.05.2017
Due date:
% Done:
100%
Estimated time:
Discuss:
Prio Planung:
Vote:
Description
- How to start Documentation for Your TYPO3 Extension - https://docs.typo3.org/typo3cms/CoreApiReference/ExtensionArchitecture/Documentation/Index.html
- HowToDocument: https://docs.typo3.org/typo3cms/HowToDocument/Incoming/Index.html
- RenderTYPO3DocumentationGuide: https://docs.typo3.org/typo3cms/RenderTYPO3DocumentationGuide/ProjectsOnGithub/Index.html
Die Doku muss nach Installation der QFQ Extension im T3 BE lesbar sein.
- Laut https://docs.typo3.org/typo3cms/HowToDocument/Incoming/Index.html soll man die Doku via einem GitHub Account / Projekt rendern lassen.
- Anschliessend kann man die File Strutktur in das eigene Projekt einbauen.
- Das aktuelle Settings.yml ist nicht mehr aktuell. Neu wird ein Settings.cfg verwendet: http://mbless.de/blog/2015/10/24/a-new-task-for-an-old-server.html#ini-files
- Github Account angelegt.
- Wie auf der Seite beschrieben hat CR eine Mail mit Freischaltung beantragt
https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-000/
Updated by Carsten Rose almost 7 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
Updated by Carsten Rose almost 7 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
Updated by Carsten Rose almost 7 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
Updated by Carsten Rose almost 7 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.
- 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.
Updated by Carsten Rose almost 7 years ago
Anfrage wie lokal dokumentieren: https://forum.typo3.org/index.php/t/216000/
Updated by Carsten Rose over 6 years ago
- Tracker changed from Support to Feature
Updated by Carsten Rose almost 6 years ago
- Status changed from In Progress to Closed
Updated by Carsten Rose over 5 years ago
Im QFQ Makefile wird neu nach dem einchecken in das github Projekt der Trigger ausgeloest zum rendern:
Updated by Carsten Rose over 5 years ago
- Target version changed from next9 to 18.9.2
Actions