Documenting webpackage tools

[dauwhe]

Having some minimal documentation for webpack would be helpful for those of us not fluent in Golang.

[jyasskin]

You're looking for documentation on the tool in https://github.com/dimich-g/webpackage/tree/master/go/webpack/cmd/wpktext2cbor, right? Yep, I should write some, but it'll probably come behind some more elaboration of the loading model.

[bmeck]

make sure to call it Webpackage, https://github.com/webpack is already a very large ecosystem for the web

[TheLarkInn]

Yes please!! ♥️

[dauwhe]

A few notes on my initial experiences with the tool:

1. In the Readme, the command go install github.com/WICG/webpackage/tree/internet-draft/go/webpack/cmd/wpktext2cbor didn't work for me. At least when downloading the master branch here, I had a path closer to github.com/WICG/webpackage/go/webpack/cmd/wpktext2cbor, and for some reason I had to go into the webpack directory and do go install ./....

2. The wpktext2cbor takes two parameters. -i points to a "manifest*" file (not the web app manifest!), with format like

[Content]
https://dauwhe.github.io/html-first/MobyDickNav/index.html

200
Content-Type: text/html
Date: Wed, 15 Nov 2016 06:25:24 GMT
Expires: Mon, 01 Jan 2018 16:00:00 GMT

MobyDickNav/index.html

https://dauwhe.github.io/html-first/MobyDickNav/html/cover.html

200
Content-Type: text/html
Date: Wed, 15 Nov 2016 06:25:24 GMT
Expires: Mon, 01 Jan 2018 16:00:00 GMT

MobyDickNav/html/cover.html

And for us HTML/XML folks, the line breaks are important :) Then the -o option points to the package file you want to create.

3. So far I can't get the package signing to work—I get the same resulting package whether or not I have a [manifest] section in the “manifest,” even when using the samples in this repo. I'll keep trying.

4. I found these tools to be helpful when playing around with this stuff, especially cbor2diag.rb.

5. As a tip for the exceedingly ignorant, like myself, the hpackdec tool takes the hpack-encoded headers (in hex, which you can get from the .wpk file by using the aforementioned cbor2diag.rb) and converts them back to "English":

cramerd$ bin/hpackdec 885F87497CA589D34D1F6196E4593E940B6A693F750400B8A01CB826EE09A53168DF6496DF3DBF4A002A651D4A08017540B97000B800298B46FF
:status: 200
content-type: text/html
date: Wed, 15 Nov 2016 06:25:24 GMT
expires: Thu, 01 Jan 2017 16:00:00 GMT
cramerd$

Now I just have to teach a service worker to do all this stuff :)

[jyasskin]

@nyaxt, could you find someone to own documentation for the tools, or decide they're already documented enough?