[kde-doc-english] Core documentation repository (was: Review Request 116038: replace old included sections with links to fundamentals)

[T.C. Hollingsworth]

Hi frameworks devs!

We thought we'd solicit some input from you all on this as well.

On Wed, Feb 26, 2014 at 3:52 PM, Luigi Toscano <luigi.toscano at tiscali.it> wrote:
> T.C. Hollingsworth wrote:
>> On Tue, Feb 25, 2014 at 4:38 AM, Luigi Toscano <luigi.toscano at tiscali.it> wrote:
>>> I'm not sure if it enough: what if fundamentals is not installed? kde-runtime as we knows is going away. Maybe we should rethink how it works.
>>
>> Well then we probably should figure out a way to make sure it's always
>> installed.  :-)  We're already linking to it heavily from other
>> docbooks and the approach really makes a lot of things easier for the
>> documentation team.
>
> And here is... the difficult part :)
> Well, it means they should be moved to some place which is always available
> when documentation is shipped with some module
>>
>> We can't just ship it with Plasma, since fundamentals is deliberately
>> designed to be useful/relevant to people using KDE applications in
>> other environments too.  (e.g. people using Kate on GNOME probably
>> still want to edit their keybindings, and kate just links to the
>> excellent shortcut configuration documentation in fundamentals).
> Exactly. It should be pushed down in the stack.
>
>
>>
>> Also, kio help:/ requires the "documentationnotfound" docbook to
>> display as sort of a 404 error, so that needs to be universally
>> available too.
> So documentationnotfound docbook should be moved together with kio-help.
>
>>
>> We could ship them with khelpcenter, but there's no guarantee that
>> that will always be the primary frontend to the help:/ kioslave, so it
>> seems like it would be nicer to find a more general home that ensures
>> it works no matter what you're using to browse help:/ URLs.
> Mhh.. that's true, so it should be in some level which is lower than kio-help.
>
>> So, perhaps we need a kde-core-docs.git or something like that to
>> house them in?  And advise distros to make sure and add runtime
>> Requires on it from kdoctools or whereever the help: kioslave is
>> shipped?  (Alternatively we could just include them in kdoctools.git,
>> but there might be a bit of a chicken and egg problem keeping docbooks
>> there?)
> Technically there is already some documentation in kdoctools, exactly as we
> had it kdelibs, so it could be included here.
>
> Do you want to raise the question on kde-frameworks-devel? I would like to
> hear from the other people in the list too.
>
> Ciao
> --
> Luigi