Re: Location of docbooks in frameworks repos
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 ___ Kde-frameworks-devel mailing list Kde-frameworks-devel@kde.org https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
Re: Location of docbooks in frameworks repos
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. -- Burkhard Lück ___ Kde-frameworks-devel mailing list Kde-frameworks-devel@kde.org https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
Re: Location of docbooks in frameworks repos
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? 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"? Regards, - Michael Pyne ___ Kde-frameworks-devel mailing list Kde-frameworks-devel@kde.org https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
Re: Location of docbooks in frameworks repos
On Wed, Mar 26, 2014 at 11:22 PM, Burkhard Lück wrote: > Hi, > > a) In kde4 docbooks usually were located in a top level folder named "doc" > in > each repo, in frameworks this folder is named "docs" with an additional > *s* , > where as the other repos with a frameworks branch seem to use the name > "doc" > (kate, kde-workspace as of now before the split etc.). > That is possibly a bit confusing and error-prone editing > documentation_paths? > > b) In kde4 we had a doc folder structure in each repo like: > > doc/app1/*docbook > doc/app2/*docbook > ... > doc/kcontrol/kcm1/*docbook > doc/kcontrol/kcm2/*docbook > ... > doc/kioslave/kio1/*docbook > doc/kioslave/kio2/*docbook > etc. > > Several scripts in l10n-kde4/script (docmessage extraction naming scheme, > autogen.sh to generate all CMakeLists.txt for installation of language > docbooks, update-xml to generate language docbooks) and the scripts on the > kde > documentation server docs.kde.org are based on such a consistent doc > folder > structure. > > I think we need a similar *consistent* scheme for docbook location in > frameworks repos. > > -- > Burkhard Lück > > ___ > Kde-frameworks-devel mailing list > Kde-frameworks-devel@kde.org > https://mail.kde.org/mailman/listinfo/kde-frameworks-devel > For the moment, what I've been doing is to follow this. I've moved the documentation into what will become the new repositories. I think it's a good way to work since it lets us to be consistent, but if somebody has a better idea then let's hear it. Aleix ___ Kde-frameworks-devel mailing list Kde-frameworks-devel@kde.org https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
