Publican Documentation Naming

Paul W. Frields stickster at gmail.com
Tue Mar 31 20:54:04 UTC 2009


On Tue, Mar 31, 2009 at 02:20:32PM -0400, Eric Christensen wrote:
> Earlier today the Fedora Packaging Committee (FPC) looked at two
> "obstacles" to Publican-generated documentation.  The first was the
> naming convention[1] and the second was how Publican handles
> the .desktop in the SPEC file[2].  Both passed the FPC.
> 
> The FPC did say that we (the Docs Project) need to create a review
> process to ask "is this documentation really version specific? is there
> value in having multiple releases in the same dist at once?".  This is
> an important test that we need to develop and handle in-house.  This is
> NOT a solution to allow all Publican documents but it is a solution for
> allowing release-specific documents in Fedora.
> 
> Also discussed was the multiple SRPMs that are generated by having
> multiple languages for each document.  To simplify the process of
> reviewing these it was suggested that we use subpackaging.  Each SRPM
> for each language would be wrapped into a single package.

Allow me to play Devil's Advocate for a moment -- one of the reasons
for splitting out SRPMs per language, AIUI, is that it allows fixed
translations to be issued quickly without having to rebuild the entire
gamut of all languages for a document.  In other words, if someone
fixes the Security Guide's German (de) translation, you can simply
issue a new release of that package, and only people with the Security
Guide installed in German will get the update.

As far as I know, you can't tell our build systems to only
release one subpackage, and hold back all the others.  So if you want
to issue an update, you would be forced to issue all languages at
once, and you push an update on everyone, even people whose content is
not changing at all.

Just my limited understanding, there may be good arguments on both
sides of course.

-- 
Paul W. Frields                                http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://redhat.com/   -  -  -  -   http://pfrields.fedorapeople.org/
  irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20090331/b8674802/attachment.bin 


More information about the docs mailing list