To be done¶
What the T3DocTeam should be tackling
What needs to be done?!
- Tasks to be done regularly
- Move documentation
- Making Documentation available
- Tools // Server // Installation
- Connect Teams
- Understanding …
- More to be done
Check whether there are open issues for the official manuals and solve them, like
Are there open pull requests? Observe https://docs.typo3.org/services/GithubPullRequests/ Become a watcher of the repositories of the official manuals at https://github.com/TYPO3-Documentation
Find out what documentation should be moved. Check:
- Continue with the “Render Documentation Guide” https://docs.typo3.org/typo3cms/RenderTYPO3DocumentationGuide/
- Continue with “rst-ing with PhpStorm” https://docs.typo3.org/typo3cms/drafts/github/wmdbsystems/RSTingWithPhpStormGuide/
- Continue with https://docs.typo3.org/typo3cms/drafts/github/wmdbsystems/TYPO3ComposerGuide/
- Q: How do I set up PhpStorm for reST? A: See the answer (with screenshots) at
- Ask about chapter “Community Writings” (Tweet)
((idea for a topic at docs.typo3.org))
Extensions - and what their developers and the community says.
2016-11-14 by François Suter at Forge:
Version 3.0 released and moved to GitHub
The road to devlog version 3.0 has been long and bumpy indeed. Years ago Fabien Udriot started a brand new version for TYPO3 4.5, using ExtJS for the backend module. The work was never finished and ExtJS fell from grace. The project lay dormant for a couple of years. Then an attempt was made to base the devlog on TYPO3’s logging API, but this also faltered along the way.
About last year I finally found the motivation to give the project yet another fresh start. Alternating sprints and breaks, the new version was eventually ready. It is entirely rewritten, with a squeaky clean code base. The backend module relies on jQuery and DataTables for paginating, searching and filtering. The “Clear log entries” feature is now available from a convenient drop-down.
The devlog also now uses a concept of log writers, which makes it possible to route devlog calls to different outputs/storages. By default, the extension provides a database and a file writer.
Last but not least, I moved the extension to GitHub. Hopefully this will help people contribute and maybe also shift ownership to someone else, as I don’t feel like continuing to maintain this extension. New home: https://github.com/fsuter/devlog
These Q & A are especially important in the context of working with the T3DocumentationStarter projects.
Example Gist: ActionViewhelper by Xavier, 2016-11-15
Leads to questions: ➊ How can documentation help to provide and share viewhelpers? ➋ Will Gists stay forever? I mean, as long as Github exists and the owner doesn’t delete them. ➌ I you have new insights, you’ll update the Gist probably? ➍ Can Gists help in creating a Viewhelper library? ➎ Can Gists help in creating a snippet collection?
- Elastic Search
- Add a cronjob that removes the
RenderDocumentationjob had failed to do so. Otherwise it would take x seconds for the lockfile to become outdated. Currently x is set to 3.600 seconds. That means, that in case the buildjob dies with an unhandled exception it will take an hour until any manual will be rendered again.
See the issues! Just to list some here:
- Make headlines better distinguishable (Tweet)
This should als cover the information of Sphinx-Doc Installation Steps (2015).
Keep an eye on the section about the
_makefolder. Provide a suitable