[TYPO3-doc] Fragmented wiki.typo3.org

François Suter fsu-lists at cobweb.ch
Fri Mar 28 11:34:31 CET 2014


Hi Daniel,

> So the main source to contribute should be here?
> https://git.typo3.org/Documentation/ (docs.typo3.org)

Yes. There's one repo per manual, plus some related to the 
docs.typo3.org infrastructure.

> So do you have any kind of a guideline what should be done in docs and
> what on wiki?

Not really strict. Basically we have a list of documents which are 
considered official. Anyone is free to propose a new manual and the 
Documentation Team will evaluate if it is a useful addition. The whole 
point is that the official documentation contains only tried and tested 
advice and examples, which cannot be guaranteed by community 
contributions in the wiki, although one hopes all such contributions are 
serious. Furthermore, the official documentation is actively maintained 
(except for some manuals, due to lack of manpower), which is definitely 
not true for wiki content.

> So as you mentioned, "Fluid" and "Extbase" are some kind of exceptions? ;)
> http://forge.typo3.org/projects/typo3v4-mvc/wiki
> http://wiki.typo3.org/Fluid

AFAIK the Forge wiki is maintained by the Extbase team, the main wiki by 
the community, but I may be wrong. All that is due to lack of official 
manual. The situation would be much clearer if there was one.

> Don't get me wrong, i just try to understand what kind of rules you try
> to follow ;)

No problem, I hope it is a bit clearer now.

> Am I right with the following sentence, the main purpose is...
> - ...docs.typo3.org should be the place of the "official" documents
> - ...wiki.typo3.org should be a place to unite the community stuff and
> adding any kinds of additions to "support" the docs

Yes. The wiki is also a good place to prepare a manual before it becomes 
official. This is what we did for the templating tutorial.

> So in fact:
> You do not have any doubts about "restructuring" as soon as the old
> contents are not effected or at least a better alternative is available?

Absolutely.

> Beside, I fear the bigger amount of effort to contributing small pieces
> to the docs, keeps people from sharing knowledge. IMMO the wiki is still
> more suitable for this.

That's true and can't be avoided IMO. We have stared experimenting with 
Github forks, which make it easier to contribute, but it is available 
only for the TSref for now and we have not really yet officialised this 
way of contributing.

On top of that there's still the idea of having comments on 
docs.typo3.org at some point in time, but all efforts have faltered so 
far, due to a lack of agreement on the commenting system to use. This 
would obviously enable simple user contributions.

Cheers

-- 

Francois Suter

Work: Cobweb Development Sarl - http://www.cobweb.ch

TYPO3: Help the project! - http://typo3.org/contribute/

Appreciate my work? Support me -
http://www.monpetitcoin.com/en/francois/support-me/



More information about the TYPO3-project-documentation mailing list