ANNOUNCEMENT: Live Wireshark University & Allegro Packets online APAC Wireshark Training Session
July 17th, 2024 | 10:00am-11:55am SGT (UTC+8) | Online

Ethereal-dev: [Ethereal-dev] Set a link from the webpage to the development part wiki / move t

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

From: Ulf Lamping <ulf.lamping@xxxxxx>
Date: Sat, 12 Mar 2005 12:50:04 +0100
Hi!

What about moving the complete content of the development pages to the wiki? http://www.ethereal.com/development.html -> http://wiki.ethereal.com/Development That way, me and others can edit things, and in the long term, we could have every piece of devel info in one place.


The evolvement so far in the developer docs (beside the webpage):
- README files (ASCII)
- doxygen (HTML)
- Developer Guide (docbook)
- Wiki (HTML, currenty unsorted)
.
I've started the Developer Guide before the wiki were there. The disadvantage of docbook is, that only a few of us (currently only me :-) seem to know docbook enough and take the time to write things in it.

Since we have the wiki, I didn't do much with docbook, as editing the wiki is much faster, more pleasant and convenient to use in my eyes.

So I'm currently a bit unsure how to go on from here. My feeling is, that it might be the best idea to move all "written" stuff to the wiki, so all developers are able to edit things. That way we might get improvements not only done by the happy few of us knowing docbook or being able to check things into SVN. In opposite to this, the doxygen tags might do the API documentation, which seems to be a good combination in my eyes.

One disadvantag is, that there's currently no way to download things from the wiki for offline reading.

What do other's think?


So Gerald, if you don't mind, I could move and convert the webpage content.

Regards, ULFL

P.S: The User's Guide is a completely different task, where we should keep the docbook. For the user's guide there should be a single way to download stuff, and it is almost complete in itself already today so minor changes needed.