[Typo3-typo3org] documentation.typo3.org

Kasper Skårhøj kasper2005 at typo3.com
Wed Apr 13 14:33:57 CEST 2005

My overall suggestion is this:

- Remove all documentation (in SXW formats or the like) from inside the
extensions => Result: MUCH smaller size of TER which will be another
helping factor for the TER
- Create a documentation repository which can be hosted seperately and
geared for presenting document.

Having extension code and documents separate will also make it easy to
make updates to either independantly which is quite often nice to do.

A suggestion for a documentation repository could be to establish it in
the folder "typo3conf/doc/" inside where each document will be named
[extension-key].[pdf/sxw/html] - or maybe in sub-dirs. 

More comments:


>  - Keep documentation in the extension directory *locally* (in doc/)


>  - In the extension manager provide two checkboxes:
>     [ ] upload extension
>     [ ] upload documentation


>  - extension and documentation will be uploaded to different servers
>    (TER / documentation.typo3.org or call it TDR?)


>  - the documentation site generates multiple formats automatically

Yes. But don't spend oceans of time on this.

>  - how can we keep or improve usability on the typo3.org site?
>    it would be a weird browsing experience to search the extension
>    on one site and read the documentation on the other. 

I don't think its a problem.

>  - what can we learn from other projects?
>  - how can we mirror the documentation site? I suggest mirroring only
>    the *end-product*, ie. the html, pdf, xml, sxw files, and not let the
>    mirror sites render these formats from the source format


- kasper

Happy new year! - My email address is now: 

		kasper2005 at typo3.com 

More information about the TYPO3-team-typo3org mailing list