[Bro-Dev] #563: Check topic/broccoli-manual-rest
Bro Tracker
bro at tracker.bro-ids.org
Wed Sep 7 16:29:20 PDT 2011
#563: Check topic/broccoli-manual-rest
----------------------------+------------------------
Reporter: robin | Owner: jsiwek
Type: Merge Request | Status: assigned
Priority: Low | Milestone: Bro1.6
Component: Broccoli | Version: git/master
Resolution: | Keywords:
----------------------------+------------------------
Comment (by jsiwek):
> > The best way of integrating those into the `www` is still an open
question
> > (I'm trying to figure out a good scheme to collect/group
documentation
> > according to Bro version)
>
> I have put a bit of machinery in place for that already, via checking
> out specific tags. But I'm not really happy with it yet.
Yeah, the current problem I was running into is that grabbing something
from a given tag of a given repo isn't enough -- it seems like we'd want
to create self-contained bundles of documentation per Bro release, which
means we'd need to be able to grab submodule documentation according to
the commit that was used for a given Bro tag. Gitweb doesn't understand
what a submodule is so you can't get the submodule commit hash that way.
I think it needs to change to just using a local clone of the Bro
repository to pull files into the `www` repo for later rendering.
> > but I think you can consider merging this branch as that gets sorted
> > out separately.
>
> Will do. Are there links from the rest docs to the Doxygen docs that
> we will need to fix later?
There's not any links between the two at the moment, we'll have to add
them.
--
Ticket URL: <http://tracker.bro-ids.org/bro/ticket/563#comment:13>
Bro Tracker <http://tracker.bro-ids.org/bro>
Bro Issue Tracker
More information about the bro-dev
mailing list