Location of docbooks in frameworks repos

Michael Pyne mpyne at kde.org
Fri Mar 28 22:45:37 UTC 2014


On Fri, March 28, 2014 10:16:29 Burkhard Lück wrote:
> Am Mittwoch, 26. März 2014, 21:04:01 schrieb Michael Pyne:
> > On Wed, March 26, 2014 23:22:22 Burkhard Lück wrote:
> > > Hi,
> > > 
> > > I think we need a similar *consistent* scheme for docbook location in
> > > frameworks repos.
> > 
> > Agreed.
> > 
> > You've mentioned 3 different schemes (application, kioslave, kcm modules).
> > Is the full list of possible schemes to be used published somewhere (e.g.
> > community.kde.org) or is this unwritten convention at this point?
> 
> We use only application, kioslave, kcm modules, not more, and it is just an
> unwritten convention
> 
> > Also, is there any reason that an application self-contained within a git
> > repository couldn't simply use "doc/*.docbook" or would that add
> > difficulty
> > compared to "doc/appfoo/*.docbook"?
> 
> No that does work and is already used for all git repos with a single
> application.

OK, great.

In that case I think the best thing to do might be to write up the proposed 
scheme(s) on community.kde.org, or wherever we're keeping our "how to write 
KDE docs" docs (so it's recorded somewhere easier to find in the future than a 
mailing list entry).

After that, a conversion of affected frameworks repos to conform to the 
scheme.

Anyone have any objections to that idea?

Regards,
 - Michael Pyne


More information about the Kde-frameworks-devel mailing list