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

Fabien Udriot fabien.udriot at ecodev.ch
Mon Jun 4 15:20:05 CEST 2012


>> There is one reserved subfoldername though: "_make". This subfolder is
>> entrance to the experts cave:
>>
>> Package/
>> |-- Documentation/
>>      |-- Index.rst
>>      |-- _make/   ((reserved name, optional))
>>          |-- ...  ((advanced stuff))
> 
> Much better :-)
> 
>> CodingGuidelines.git
>> |
>> |-- Documentation/
>>      |-- .gitignore           (1)
>>      |-- Index.rst
>>      |-- MorePureDocumentation/
>>      |-- ...
>>      |-- _make/
>>          |-- conf.py
>>          |-- make.bat
>>          |-- make-html.bat    (2)
>>          |-- Makefile
>>          |-- build/
>>              |-- .gitignore   (3)
>>              |-- html/
>>              |-- json/
>>              |-- singlehtml/
>>              |-- ...
>>          |-- _not_versioned/
>>              |-- .gitignore   (4)
> 
> I like that structure much better.
> 
> Xavier, Fabien, what do you think? Can this structure match the needs you highlighted?

Yes, it is representing the basic needs, as the default case, with the possibility to have more
advanced stuff. Good proposition!

A few notes / reactions:

* Just to mention, I have always seen the .gitignore file at the root of the repository (and not
like in 1,3,4).

* 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.

CodingGuidelines.git
|-- Readme.rst        (1)
|-- Documentation/
    |-- Index.rst

* 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...

Fabien



More information about the TYPO3-project-documentation mailing list