search

IETF-OPSAWG-WG / draft-ietf-opsawg-pcap

PCAP next generation file format specification
Other
264 stars 59 forks source link

Stale document - https://pcapng.github.io/pcapng/ #97

Closed bubbasnmp closed 3 years ago

bubbasnmp commented 3 years ago

Lazy googling "pcapng file format" returns https://pcapng.github.io/pcapng/ which is beautifully formatted and easy to read but out of date.

guyharris commented 3 years ago

@mcr, can we somehow arrange to have the Markdown converted either to RFC XML that we can feed to the RFC XML to xxx converters, or converted directly to HTML, so people who want to read the spec can get to a formatted document?

mcr commented 3 years ago

Guy Harris notifications@github.com wrote:

@mcr, can we somehow arrange to have the Markdown converted either to RFC XML that we can feed to the RFC XML to xxx converters, or converted directly to HTML, so people who want to read the spec can get to a formatted document?

kramdown | xml2rfc -html is as easy as just "xml2rfc -html", so if we are actively doing something then, we can just actively use markdown.

If you are asking if we can regularly commit a .html file, I do not object to that at all. That's trivial, but people hate having "output" in .github.

There is a github webhook that can be setup to have travis/circleci update the gh-pages branch which feeds the github.io. I can try to set that up next time I edit.

guyharris commented 3 years ago

There is a github webhook that can be setup to have travis/circleci update the gh-pages branch

(Sigh, why did my parents give me the same initials as GitHub? :-))

which feeds the github.io.

So does that mean that the gh-pages branch of the pcapng/pcapng repository is a "publishing source" for pcapng.github.io?

And does that web hook mean that a CI run, done whenever something's committed to the pcapng/pcapng repository, would run kramdown | xml2rfc -html to generate HTML, and then commit that HTML to the gh-pages branch, or something such as that?

Or does it do something else?

guyharris commented 3 years ago

OK, so @mcr has set up the webhook, and the current version of the pcapng draft is here.