[TYPO3-team-core-v5] TYPO3 Phoenix Scrum Meeting Notes - 21.07.2011

[Robert Lemke]

Hi François,

Am 21.07.2011 um 17:32 schrieb François Suter:

> Well, make your tests then, but please consider this very seriously. The efforts that we (the Doc Team) have already invested are far from negligible and I think quite a bit would lost, contrary to what you think (very little design work has been done yet, which is what would be mostly salvageable).

yes, I'm all aware of that.

> Please mind the pros and cons listed for DocBook:
> 
> http://wiki.typo3.org/DocTeam/DocBook_migration#Pros_and_cons
> 
> when you evaluate ReST. To this list I would actually add the ease of cross-linking (when using DocBook id's), which is a major issue (we have tons of broken links in the current documentation).

Correct. As far as I can judge, we will be able to have some reliable cross-linking functionality by using Sphinx (the ReSt standard does not provide this by default). If you like, you can read a bit about it on the Sphinx website:

http://sphinx.pocoo.org/

> I know that DocBook is not so easy to write for contributors and this was hotly debated in the documentation mailing list. We finally came to the conclusion that the added complexity was worth it compared to DocBook's feature set. We also figured that only few people are contributing to the documentation anyway and that they will probably be okay learning DocBook.
> 
> I would like to add that this is not just about me. It's also about the Doc Team and its role. We have been building it up, making it more active, more professional and I'm disappointed that discussions about the choice of a documentation format should happen among v5 team members with no coordination with the Doc Team.

I know. Really, this is "just an idea" which I came up with during the last few days, and yesterday I discussed it the first time with Sebastian. So there's no real discussion going on yet and of course no decision taken. On the other hand my gut feeling says that this might be an opportunity worth all the hassle. The whole Phoenix team also has invested quite some energy into DocBook, so it wouldn't be an easy decision for us, either.

Again, I think the best would be if I get some more insights into this and then discuss my outcome in the Doc Team mailing list. That is of course the place where it belongs to.

Don't be afraid, I'm confident that we figure out the best solution for TYPO3 and FLOW3 together, whatever format or technology that will be.

Cheers,
Robert