FYI, https://docs.zeek.org is now live with the Zeek manual hosted by
a Read the Docs custom domain (originally was hosted at
www.zeek.org/sphinx-git).
The broker and bro-pkg docs are also now available as sub-projects there:
https://docs.zeek.org/projects/broker
https://docs.zeek.org/projects/package-manager
Let me know of any problems.
- Jon
This is very cool!
It's also nice that there's an "edit" button in the sidebar that leads
directly to GitHub (not for Broker, though).
Can we keep old links into the documentation working through
redirects?
Robin
Yes, those should already be set up, but let me know if I missed
anything (note that the "release" version of the manual still lives on
zeek.org as there's not yet any release that can be build on RTD).
- Jon
Would it be worth aiming to do that update with the next 2.6.x patch
release? Would be nice to get the modern look for the release version,
too.
Robin
Not sure how worth it -- feel a bit odd/unmotivated preparing a
pure-cosmetic feature for a patch release which I usually think more
strictly in the Semantic Versioning sense as being bug fixes only, not
new features. Maybe a good segue to a separate discussion on
improving release/version planning so there's more appropriate and
frequent times to release smallish features like this?
- Jon
Both release and master versions are on RTD (docs.zeek.org) now and
build from a new zeek-docs repo on GitHub.
The 2.6.1 version was manually imported with a few tweaks to get it
working, so don't think we have to consider backporting anything into
a 2.6.x -- probably those won't change the generated docs anyway so we
can get away with just bumping a new git tag.
- Jon
Very cool!
Robin