[FLOW3-general] Documentation - Structure, Location and Organisation in the FLOW3 ecosystem

[Sebastian Kurfürst]

Hey Daniel,

really nice to have you here!
> I think that there is a general problem with the mailing list + IRC -
> system. When a new user joins, he won't have read the old messages and
> maybe is, as I am, too self conscious to ask "stupid questions" and to ask
> about everything he wants to understand *once again*.
You can find the mailing lists archives on
http://lists.typo3.org/cgi-bin/mailman/listinfo or use your newsreader
pointing to lists.typo3.org.

I know that currently the server team is in the process of setting up a
forum in sync with the mailing lists, though I do not know the exact
state here.

> Who's up-to-speed with the documentation and the "information management"?
That'd be me, or any other guy from the FLOW3 / Phoenix core team I think :)

Just ping me/us on #flow3 on irc.freenode.net and we can arrange a call.

> It'd be great to have a cookbook - like page or something where users could
> post snippets, questions & solutions and maybe general FAQ, preferably
> sorted by topic. I'd also thought about stack overflow, but maybe a
> dedicated area in a wiki might be a good enough start as well.
+1, a wiki is enough as a start.

IMHO, we should do the following:

  * use a wiki page on forge.typo3.org or wiki.typo3.org as some kind of FAQ
  * furthermore, somebody should periodically move the wiki page
    contents to the official documentation

The official documentation for FLOW3 can be found inside the package
TYPO3.FLOW3 in the folder "Documentation" as reStructured text [1]. If
you want to render the documentation, you need to install the
TYPO3.DocTools package [2] and run the following command:

./flow3 documentation:render documentation:render --format html

and then you can browse it on Data/Temporary/Documentation/.

We need any help we can get for improving the official docs, so if you
still have questions let me know!

Great to have you participating,
Sebastian


[1]
http://git.typo3.org/FLOW3/Packages/TYPO3.FLOW3.git?a=tree;f=Documentation
[2] http://git.typo3.org/FLOW3/Packages/TYPO3.DocTools.git