Documentation Team Meeting Minutes 2012-05-24¶

Attendees¶

Martin Bless, Christopher Stelmaszyk, François Suter, Fabien Udriot, Christian Wöbbeking

Topics¶

Git migration¶

• Example/Manual.git repo stays as it is
  • Rename (= delete + create) TYPO3v4/Extensions/doc_template.git ---> Documentation/TYPO3/Example/ExtensionManual.git
  • Push old SVN content of doc_template again (Christopher) + add new stuff (Fabien)
• Add missing tags
• Structure of Git repositories:
  • old stuff in "Archive"? No, let's keep tags instead.
  • reST files in "Documentation"!
• Needed state for reST?
  • Result:
    • > make master empty (Christopher)
    • > import files from reST in the Documentation folder (François)

reST migration¶

• URL/domain to put the documentation:
  • docs.typo3.org = outside of typo3.org or
  • integrate the output into typo3.org?
  • => First "only" have it outside of typo3.org on docs.typo3.org. (Integration into typo3.org maybe later, but not now.)
• only lowercase or also uppercase of folders and filenames in the URLs?
  • folder and files to be in UpperCamelCase, along FLOW3 guidelines
    • for the web server, try to make URLs case-insensitive. See: http://answers.oreilly.com/topic/108-how-to-permit-case-insensitive-urls-with-apache/ (Hint: use "CheckSpelling On" as configuration in Apache)
    • in exported reST structure:
      • change "img/" folder to "Images/".
      • rename folder + do search&replace in images.txt
      • this has to be taken care of manually before pushing to git
  • Result: A typical (frontend) URL would look like: http://preview.docs.typo3.org/TYPO3/FileAbstractionLayerReference
  • idea for later: add shortcuts for shorters URLs for important manuals (e.g. docs.typo.org/tsref or tsref.typo3.org)

To be continued on June 21st¶

Migration of sysext manuals:¶

• Three possibilities:
  • one Git repo per extension
    • There are many (59). => Would make clean repos.
  • one single repo for all
    • Is it possible to have several manuals in one "Documentation" folder? => Would be a "dirty" solution.
  • keep sysext documentation in the Core together with the code.
    • That's what FLOW3 does (writing documentation is often forgotten, if docs are in another repo)
    • seems ok to have a script that fetches manuals from source code

Keep OpenOffice possibility for a given time (or forever)?¶

• probably forever since we have to account for extensions which are not maintained anymore must still have their manuals rendered

Design for new rendering:¶

• any news from Martin Huber? Not yet.

Miscellaneous¶

• keep meeting on 3rd Thursday of every month?
  • As a basis: Yes. If needed, spontaneous meetings should be possible.
• Improve Layout of TS http://preview.docs.typo3.org/typo3/extensions/doc_core_tsref/fabien/#id78
  • work continues on this. Fabien to give feedback about changes that may be needed in original reST structure or HTML rendering
• Template Building Tutorial:
  • Christian is checking it out, will work with Christopher to suggest improvements

Next meeting¶

• Thursday, June 21st, 21:00 CET