[Haskell-cafe] is it normal for docs to be pending for 24 hours?

[Michael Snoyman]

Here were Duncan's comments at the time:

      * the docs need to match the URL scheme on hackage, in terms of
        linking back to other packages docs on hackage. This needs to be
        done using sufficiently-relative urls so that http & https
        works.
      * it's generally not desirable to overwrite/replace existing docs.
        You can check which packages are missing docs by consulting this
        resource: http://hackage.haskell.org/packages/docs.json
      * we generate the docs so that only one style is listed, so that
        haddock does not include it's style switcher menu.
      * we do include all the files haddock generates, including the
        minus.gif, synopsis.png.
      * hackage currently does not use a shared haddock css and js file
        (though doing so is a good idea), so these are also included in
        the doc bundle, just as haddock produces them.

This presumes having some kind of an upload script running from the
Stackage side, whereas my recommendation had been that Hackage be modified
to use the Stackage S3 docs as a backup for when its doc building fails.
You can see an example of generated docs at:

https://s3.amazonaws.com/haddock.stackage.org/lts-7.0/
tagstream-conduit-0.5.5.3/Text-HTML-TagStream-ByteString.html

The code which calls Haddock is available at:

https://github.com/fpco/stackage-curator/blob/master/
Stackage/PerformBuild.hs

By the way, regarding your comments about resourcet and FP Complete: I'm
honestly offended at this tone. I've clearly attempted quite often and
quite sincerely to get such cooperation to happen, and have been rebuffed.
Even if you're unaware of that, the implied accusation assumes a lot which
isn't true. I honestly considered ignoring this thread entirely based on
this tone, I'm tired of dealing with it.

On Sun, Nov 13, 2016 at 8:59 AM, Patrick Pelletier <code at funwithsoftware.org
> wrote:

> Can you share the list of requested changes?  And what is the cause of the
> difference?  Is Stackage running Haddock with different options than
> Hackage does?  Or is it doing something other than just running Haddock?
> Is the code that builds the Stackage docs available?
>
> --Patrick
>
>
>
> On 11/12/16 10:46 PM, Michael Snoyman wrote:
>
> I shared this thought privately before, but worth sharing publicly if
> someone wants to try following up on it: all of the docs build for the
> Stackage server are available on S3, and could by leveraged by Hackage as
> well. When I brought this up earlier, there was a large-ish list of
> requested changes to the generated HTML, which I didn't want to implement,
> but perhaps someone can find a way to bridge the gap.
>
> On Fri, Nov 11, 2016 at 6:43 PM, Gershom B <gershomb at gmail.com> wrote:
>
>> Sorry — the builder for docs has been in rough shape and we’re working on
>> it. In this case it got stuck due to disk space issues and monitoring
>> didn’t catch it. Its now running again but doing some catching up. (And
>> lots of stuff in the queue it failed to build due to other problems needs
>> to be replaced there, which is a manual process at the moment if we don’t
>> want the queue as a whole to just drown out any new things at all with
>> backlog). It would be much better to expose more queues and have better
>> monitoring (and real prioritization), and another volunteer to help ben out
>> on this would be very welcome (please contact me if you’re interested — the
>> code lives at https://github.com/haskell/hackage-server/blob/master/Bui
>> ldClient.hs and there’s some uncommitted work on queuing as well).
>>
>> —gerhsom
>>
>> On November 8, 2016 at 8:37:19 PM, Patrick Pelletier (
>> code at funwithsoftware.org) wrote:
>> > This is only my second time uploading a package to Hackage, so I don't
>> > yet have a feel for how it's supposed to go. I uploaded
>> > normalization-insensitive-2.0.0.1 about 24 hours ago:
>> >
>> > https://hackage.haskell.org/package/normalization-insensitive-2.0.0.1
>> >
>> > Under "Status", it says "Docs pending". (And the module names are all
>> > non-clickable.) Is it normal to take this long to build the docs? Is
>> > there some way to find out where in the queue my job is? Is this an
>> > indication that something has gone wrong? How do I fix it?
>> >
>> > Thanks,
>> >
>> > --Patrick
>> >
>> > _______________________________________________
>> > Haskell-Cafe mailing list
>> > To (un)subscribe, modify options or view archives go to:
>> > http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
>> > Only members subscribed via the mailman list are allowed to post.
>>
>> _______________________________________________
>> Haskell-Cafe mailing list
>> To (un)subscribe, modify options or view archives go to:
>> http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe
>> Only members subscribed via the mailman list are allowed to post.
>>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/haskell-cafe/attachments/20161113/f98f9b64/attachment.html>