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

T.C. Hollingsworth tchollingsworth at gmail.com
Wed Feb 26 22:46:01 UTC 2014


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.

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

Also, kio help:/ requires the "documentationnotfound" docbook to
display as sort of a 404 error, so that needs to be universally
available too.

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.

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?)

fundamentals, documentationnotfound, and maybe onlinehelp would fit
quite nicely in such a repo, and there's probably more stuff we'd want
to add later on.

-T.C.


More information about the kde-doc-english mailing list