[TYPO3-dev] Ending usage of the Pending Documentation page

[Ernesto Baschny [cron IT]]

Hi,

this might sound like a good idea in an "ideal world", but it makes the
maintenance of the documentation much more complicated. We hardly have
manpower to do it in the current way, and the work done by Francois in
reorganizing it takes the "real live" situation on how we deal with it
into consideration.

To my understandings, these are the factors that would speak against
your proposal:

- branching and timing of official documentation and release would have
to be tied together. Currently this is definitively not going to be
possible (due to manpower)

- it's not the core team that updates the documentation, it's the
documentation team. Meaning that technically it has to be a different
repository with different permissions and team members

- we don't want to "pollute" the core issue tracker with yet another
Category just for updating the documentation

- we don't really update all official documentation on *every* releases:
we just don't have that much manpower! So having for example the
"Getting started" document in all Core branches makes it appear that we
have them up-to-date while it is not so.

- ... fill more reasons here ...

And at the end, I don't see any reasons not to have one repository per
documentation, and having them branches independent of the core, however
it makes sense to that specific documentation. That doesn't mean that we
won't have a TSref for every Core release, but they are released
independently of the Core.

Cheers,
Ernesto

Adrien Crivelli schrieb am 24.10.2011 05:13:
> I agree with Kay on this, to have documentation source in the same
> repository as code source is definitively the best way to keep both of them
> in sync. It is also much easier to find it for developers. We don't split
> code and documentation for extensions, I don't know why it should be any
> different for core.
> 
> Also it is not exclusive with publicly hosting HTML output. Using standard
> path ("/doc/") would easily allow for automated fetching and "compiling" of
> several documentation sources, even for several versions (similar to what
> was done for http://api.typo3.org/).
> 
> 
> On 22 October 2011 16:10, Kay Strobach <typo3 at kay-strobach.de> wrote:
> 
>> But this way we could have the docu in the core, which corresponds with
>> the installed version?!
>>
>> Regards
>> Kay
>>
>> Am 21.10.2011 19:06, schrieb François Suter:
>>> Hi,
>>>
>>>> Wouldn't it be best to have parts of the docu in the core, this way the
>>>> change in the rest Manual can be committed with a single patch ...
>>>
>>> Definitely not, as it would  mean we could not update documentation
>>> independently of the Core. Furthermore we are rather pursuing the
>>> opposite goal: with the move to reST we aim to move the sysext manuals
>>> out of the Core so that the whole Core-related documentation can be
>>> handled in a common way, which is not the case now. In particular the
>>> sysext manuals are nowhere available online in HTML format, which is bad.
>>>
>>> Cheers
>>>
>>
>>
>> --
>> http://www.kay-strobach.de - Open Source Rocks
>>
>> TYPO3 .... inspiring people to share!
>> Get involved: http://typo3.org
>>
>> Answere was usefull: https://flattr.com/profile/kaystrobach
>> _______________________________________________
>> TYPO3-dev mailing list
>> TYPO3-dev at lists.typo3.org
>> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-dev
>>