Debian Bug report logs - #616548
RFP: puppet-doc -- puppet documentation for offline reading

Package: wnpp; Maintainer for wnpp is wnpp@debian.org;

Reported by: Stefano Zacchiroli <zack@debian.org>

Date: Sat, 5 Mar 2011 12:45:01 UTC

Severity: wishlist

Reply or subscribe to this bug.

Toggle useless messages

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to debian-bugs-dist@lists.debian.org, Puppet Package Maintainers <pkg-puppet-devel@lists.alioth.debian.org>:
Bug#616548; Package puppet. (Sat, 05 Mar 2011 12:45:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefano Zacchiroli <zack@debian.org>:
New Bug report received and forwarded. Copy sent to Puppet Package Maintainers <pkg-puppet-devel@lists.alioth.debian.org>. (Sat, 05 Mar 2011 12:45:04 GMT) Full text and rfc822 format available.

Message #5 received at submit@bugs.debian.org (full text, mbox):

From: Stefano Zacchiroli <zack@debian.org>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please ship upstream documentation for offline reading
Date: Sat, 05 Mar 2011 13:42:30 +0100
Package: puppet
Version: 2.6.5-1
Severity: wishlist

As per subject, it would be wonderful to have a puppet-doc package shipping the
documentation available at <http://docs.puppetlabs.com>.  Rationale: although
online documentation is handy, sometimes it's really useful to have
documentation available for offline reading.  (Bonus point if, in doing that,
you also register it with doc-base, that would be awesome!)

Thanks a lot for maintaining puppet!
Cheers.

-- System Information:
Debian Release: wheezy/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.37-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=it_IT.utf8, LC_CTYPE=it_IT.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages puppet depends on:
ii  puppet-common                2.6.5-1     Centralized configuration manageme
ii  ruby1.8                      1.8.7.334-1 Interpreter of object-oriented scr

Versions of packages puppet recommends:
ii  ruby [rdoc]                   4.5        An interpreter of object-oriented 

Versions of packages puppet suggests:
ii  etckeeper                     0.52       store /etc in git, mercurial, bzr 
ii  puppet-el                     2.6.5-1    syntax highlighting for puppet man
pn  vim-puppet                    <none>     (no description available)

-- no debconf information




Information forwarded to debian-bugs-dist@lists.debian.org, Puppet Package Maintainers <pkg-puppet-devel@lists.alioth.debian.org>:
Bug#616548; Package puppet. (Sun, 30 Sep 2012 02:33:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to Micah Anderson <micah@riseup.net>:
Extra info received and forwarded to list. Copy sent to Puppet Package Maintainers <pkg-puppet-devel@lists.alioth.debian.org>. (Sun, 30 Sep 2012 02:33:03 GMT) Full text and rfc822 format available.

Message #10 received at 616548@bugs.debian.org (full text, mbox):

From: Micah Anderson <micah@riseup.net>
To: Stefano Zacchiroli <zack@debian.org>, 616548@bugs.debian.org
Subject: Re: Bug#616548: please ship upstream documentation for offline reading
Date: Sat, 29 Sep 2012 22:29:12 -0400
[Message part 1 (text/plain, inline)]
Hi hi zack!

> As per subject, it would be wonderful to have a puppet-doc package shipping the
> documentation available at <http://docs.puppetlabs.com>.  Rationale: although
> online documentation is handy, sometimes it's really useful to have
> documentation available for offline reading.  (Bonus point if, in doing that,
> you also register it with doc-base, that would be awesome!)

that would be nice! So nice that I started to go down that path to create that
lovely package. Unfortunately, it wasn't long until I was tearing my hair out
and putting out my eyes.

I got the upstream git repository from github, there are no releases, so that is
pretty annoying, but I can live with that. I created a git repository underneath
the puppet git hierarchy in alioth
(git://git.debian.org/collab-maint/puppet-doc.git). That all went well, not a
surprise there. It quickly went downhill once I started to look at the
README.markdown.

First I found that you have to initialize git submodules, to pull in some other
repositories, I really dont have any clue how to deal with that in a debian
package. It is just for the marionette-collective, but sadly it is the entire
source repository for that projcet. Errr.... so I just ignore that for now. Then
it helpfully suggests the various packages that need to be installed, those are
easily added to debian/control, thats easy, maybe things wont be that bad. But
then it starts talking about the ruby gems that are needed, about half of those
exist as packages, the rest don't, err ok....

Lets pretend that never happened, and continue looking at things. The next step
details how you need to run 'rake generate' and then:

2.  Start a little server to view it at http://localhost:9292:

        $ rake serve

oh my.

I think this is where I started to talk like chewbacca, and people around me
began to worry about my sanity.

I decided to keep ignoring things and moved on to other steps, hey maybe I can
just build and ship the HTML pages. All I need to do is:

Build Updated HTML Manpages
---------------------------

    $ PUPPETDIR=~/Documents/puppet rake update_manpages

You will need to point the PUPPETDIR environment variable at a git checkout of
the Puppet code

Oh. That is not nice. I need a checkout of the puppet source to build this? This
is where I turned into the hulk and smashed many, many buildings. I requested
the damage bill sent to Debian, I hope that is ok.

Once I calmed down, I decided that maybe I could just jam all the markdown
source files into /usr/share/doc/puppet-doc and then go home and cry in the
corner. Then I found that the source package has all kinds of stuff, like
unlicensed fonts, javascript and PDFs without source, and the mess was just too
much.

I'm pushing the git repository now, and going to have a beer and squash some RC
bugs instead!

micah
[signature.asc (application/pgp-signature, inline)]

Bug reassigned from package 'puppet' to 'wnpp'. Request was from Antoine Beaupré <anarcat@debian.org> to control@bugs.debian.org. (Sun, 30 Sep 2012 02:57:03 GMT) Full text and rfc822 format available.

No longer marked as found in versions puppet/2.6.5-1. Request was from Antoine Beaupré <anarcat@debian.org> to control@bugs.debian.org. (Sun, 30 Sep 2012 02:57:03 GMT) Full text and rfc822 format available.

Changed Bug title to 'RFP: puppet-doc, puppet documentation for offline reading' from 'please ship upstream documentation for offline reading' Request was from Antoine Beaupré <anarcat@debian.org> to control@bugs.debian.org. (Sun, 30 Sep 2012 02:57:04 GMT) Full text and rfc822 format available.

Changed Bug title to 'RFP: puppet-doc -- puppet documentation for offline reading' from 'RFP: puppet-doc, puppet documentation for offline reading' Request was from Bart Martens <bartm@debian.org> to control@bugs.debian.org. (Sun, 30 Sep 2012 05:03:05 GMT) Full text and rfc822 format available.

Information forwarded to debian-bugs-dist@lists.debian.org, wnpp@debian.org:
Bug#616548; Package wnpp. (Sun, 30 Sep 2012 08:27:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefano Zacchiroli <zack@debian.org>:
Extra info received and forwarded to list. Copy sent to wnpp@debian.org. (Sun, 30 Sep 2012 08:27:03 GMT) Full text and rfc822 format available.

Message #23 received at 616548@bugs.debian.org (full text, mbox):

From: Stefano Zacchiroli <zack@debian.org>
To: Micah Anderson <micah@riseup.net>
Cc: 616548@bugs.debian.org
Subject: Re: Bug#616548: please ship upstream documentation for offline reading
Date: Sun, 30 Sep 2012 10:22:44 +0200
[Message part 1 (text/plain, inline)]
On Sat, Sep 29, 2012 at 10:29:12PM -0400, Micah Anderson wrote:
> I'm pushing the git repository now, and going to have a beer and squash some RC
> bugs instead!

Thanks:

- for trying
- for the forthcoming RC bugs fixes
- and for making my day with this tale :-)

feel free to do whatever you please with this bug report, maybe it'd be
useful for other to mark as wontfix, if anyone else in the future try to
turn you into Hulk-mode again.

Cheers.

PS no, the building bill is *not* fine :-P
-- 
Stefano Zacchiroli  . . . . . . .  zack@upsilon.cc . . . . o . . . o . o
Maître de conférences . . . . . http://upsilon.cc/zack . . . o . . . o o
Debian Project Leader . . . . . . @zack on identi.ca . . o o o . . . o .
« the first rule of tautology club is the first rule of tautology club »
[signature.asc (application/pgp-signature, inline)]

Send a report that this bug log contains spam.


Debian bug tracking system administrator <owner@bugs.debian.org>. Last modified: Sat Apr 19 02:45:32 2014; Machine Name: buxtehude.debian.org

Debian Bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.