Work Package #45004

Write TYPO3 Neos Integrator Guide

Added by Sebastian Kurfuerst over 8 years ago. Updated over 8 years ago.

Status:
Accepted
Priority:
Must have
Category:
Documentation
Target version:
Start date:
Due date:
2013-05-31 (over 8 years late)
% Done:

60%

Estimated time:
60.00 h
Spent time:

Description

Write TYPO3 Neos Integrator Guide

  • Target Audience: developers and integrators who want to use Neos
  • Responsible: Karsten Dambekalns <karsten (at) typo3 (dot) org>
  • Implemented by: Karsten Dambekalns, Sebastian Kurfürst <sebastian (at) typo3 (dot) org>
  • Amount: 10 work days
  • Version: must have for 1.0
  • Planned Implementation Timeframe: week 12 to 15, 2013

Motivation

Anyone who is about to build a website using TYPO3 Neos needs to be able to have the needed knowledge available in a nice to read documentation. The same is true for developers about to write plugins for Neos or work on the system itself.

In the past the lack of documentation for TYPO3 has always been mentioned (justified or not) as an impediment for adoption. And even those who recognized the existing documentation complain about the learning curve.

Goal

To make it easy for integrators and developers to get into TYPO3 Neos it is thus needed to have documentation available that is concise, easy to understand and available at an early point in the product lifecycle.

What has been started at https://review.typo3.org/17510 will be used as base for this.

Deliverables

  • Integrator topics to be covered [MUST]
    • ✔ Installation / Getting started
    • ✔ TYPO3CR: structure, nodes and content types
    • ✔ How a page is rendered
    • ✔ Using custom templates for the site and custom elements
    • ✔ TypoScript introduction
    • Using TypoScript to tweak rendering (cookbook style)
    • TypoScript objects and Patterns (TODO Sebastian)
    • ✔ TypoScript inside (concepts and motivation on TypoScript)
    • ✔ Creating custom content types
    • Configuring Neos UI elements for types
    • Creating a plugin for Neos (TODO: should be Developer Guide, not Integrator Guide)
    • Localisation using a multi-tree approach
    • Site deployment (using Surf)
  • Neos developer topics to be covered [MUST]
    • Coding guidelines
    • Working on the UI
    • FE system architecture
    • (TODO Sebastian) Diagram: How the content module works (and a little text)
    • Creating custom "backend" modules
  • ✔ have the guide rendered on docs.typo3.org [MUST]
  • ✔ have the guide advertised/linked on neos.typo3.org [MUST]
  • ✔ written in english [MUST]
  • proofread by a native speaker

Files

typo3neos-distribution-base-45004.pdf (4.42 KB) typo3neos-distribution-base-45004.pdf Sebastian Kurfuerst, 2013-02-16 15:18

Related issues

Related to Base Distribution - Story #41586: write Neos Integrator GuideAcceptedSebastian Kurfuerst

Actions
Related to Base Distribution - Story #44970: Define Neos 1.0 APINewRobert Lemke2013-01-30

Actions
Related to Base Distribution - Task #45032: Oudated install documentationResolvedKarsten Dambekalns2013-01-31

Actions
Related to Base Distribution - Task #45033: Should we really suggest '--dev' for demo installation?ResolvedKarsten Dambekalns2013-01-31

Actions
Related to Base Distribution - Task #45034: Mention setfilepermissions in install instructionsResolvedKarsten Dambekalns2013-01-31

Actions
Related to Base Distribution - Story #44969: Document Two-Tree Localization ApproachNew

Actions
Related to Base Distribution - Task #45035: 'First visit' guideNew2013-01-31

Actions
Related to Base Distribution - Task #46722: Check/update "Your first plugin"ResolvedKarsten Dambekalns2013-03-27

Actions
#1

Updated by Sebastian Kurfuerst over 8 years ago

  • Subject changed from Write TYPO3 Neos Integrator Guide to [WIP] Write TYPO3 Neos Integrator Guide
  • Assignee set to Karsten Dambekalns
#2

Updated by Karsten Dambekalns over 8 years ago

  • Subject changed from [WIP] Write TYPO3 Neos Integrator Guide to Write TYPO3 Neos Integrator Guide
  • Category set to Documentation
#3

Updated by Sebastian Kurfuerst over 8 years ago

If possible, please also fix #45032, #45033, #45034; absolute bonus: #45035

#4

Updated by Sebastian Kurfuerst over 8 years ago

  • Status changed from New to Accepted
#5

Updated by Sebastian Kurfuerst over 8 years ago

Has been discussed with Jan-Hendrik from the EAB on 12.02.2013; and has been accepted on 15.02.2013 by the EAB.
(The attached PDF is a snapshot of this work package at the time of acceptance.)

So, Karsten (and myself), you can schedule this work package in your day-to-day calendar and implement it then -- can't wait to see it in Neos 1.0 :-)

Another side-note: Please do not forget to add comments to this work package and update "% done" while you are working on this package.

Greets, Sebastian

#6

Updated by Karsten Dambekalns over 8 years ago

Awesome, I just noticed that adding subtasks makes it impossible to set the estimated time on the parent task. Sigh.

#7

Updated by Karsten Dambekalns over 8 years ago

  • Estimated time set to 60.00 h
#8

Updated by Karsten Dambekalns over 8 years ago

Karsten Dambekalns wrote:

Awesome, I just noticed that adding subtasks makes it impossible to set the estimated time on the parent task. Sigh.

I undid that and moved the logged time from the subtasks to this one. Awesome. :)

#9

Updated by Karsten Dambekalns over 8 years ago

  • % Done changed from 0 to 10
#10

Updated by Aske Ertmann over 8 years ago

Would it make sense to set the due date to the end of week 15?

#11

Updated by Bastian Waidelich over 8 years ago

  • Due date set to 2013-04-20

Just set the due date in order to make it visible in the work package listing at http://neos.typo3.org/work-packages.html

#12

Updated by Karsten Dambekalns over 8 years ago

  • Due date changed from 2013-04-20 to 2013-05-17

Set the due date (aka target date) into the future - after our Neos sprint this should be done, I hope.

#13

Updated by Karsten Dambekalns over 8 years ago

  • % Done changed from 10 to 20
#14

Updated by Karsten Dambekalns over 8 years ago

  • % Done changed from 20 to 30
#15

Updated by Sebastian Kurfuerst over 8 years ago

  • % Done changed from 30 to 70
#16

Updated by Sebastian Kurfuerst over 8 years ago

  • Due date changed from 2013-05-17 to 2013-05-31
  • % Done changed from 70 to 60

Also available in: Atom PDF