[TYPO3-doc] Official docs: Mostly CamelCased now (to be pushed again)

Fabien Udriot fabien.udriot at ecodev.ch
Fri Jun 8 15:07:24 CEST 2012



>> * When cleaning up the files, we could introduce a "Readme.rst" at the root of the repository as a
>> good practice. See below (1) if unclear. This files would contains info towards new users so that
>> they would know at a glance what it is about. The content of the file could be "injected" in the
>> main documentation by the include directive in file Index.rst whenever rendering. Readme file is a
>> standard on many development platform and people are used to it.
> 
> I could imagine having such a file as a replacement for the current plain-text README, but I
> wouldn't reuse it in the documentation. The question is about it's real use. If it's not used in the
> documentation it does not need to be in reST. Plain-text is fine. On Github it's common to have the
> README in  markdown format. Does reST work too? If not, I would not impose any standard and let
> developers adopt whatever they feel works best (unless we get a Github-like feature on Forge).

Yes, it does. Here is a link to summarize all README format supported by Github.
https://github.com/github/markup#markups

If we have a single format, README included, for all our docs, that would be better IMO.

>> * Are we going to add a "ext_emconf.php" file? More than the need to install the documentation
>> package in the Extension Manager, the file contains metadata information that are standardized
>> across TYPO3 extensions that we can extract at the rendering stage...
> 
> The official documentation is not meant to be extensions anymore, so I would say no. I don't think
> we need that. And FLOW3 packages don't have that anyway, so it's a "standard" only with regards to
> actual TYPO3 v4/6 extensions.

FLOW3 / Phoenix would have their "Package.xml" file but it doesn't change the idea that there is
informations / metadata in the package that we can take advantage when it comes about docs
rendering. Otherwise, how (and where) would do you handle the version number of the docs? And the
title? I am not keen of having this info duplicated... furthermore, I wouldn't separate too much
official documentation from extension manual on this question. It is just more work to support
different way of doing within the build chain.

Have a nice weekend!

Cheers,

Fabien



More information about the TYPO3-project-documentation mailing list