From: Michalis K. <mic...@gm...> - 2017-01-08 04:17:40
|
Hi everyone! Our wiki, which serves as our main website, has been moved to https://github.com/michaliskambi/pasdoc/wiki Please take a look, and update your bookmarks:) The new wiki was converted from the MoinMoin content (somewhat automatically, and then I did a lot of manual fixes:). Along the way, I improved and cleaned up some pages. I hope that the new sidebar is also helpful: it's a prominent "table of contents" for the wiki, visible on every page. At the end, we have 99 (exactly!) pages in our wiki:) Please take a look, and report if you find anything incorrect. Or, even better, go ahead and fix it yourself!:) It's a wiki, and it should be open for public editing (you should only need a GitHub account; please email me if it doesn't work). Why: Our previous wiki (now retired), was hosted on http://pasdoc.sipsolutions.net/ . It was using the MoinMoin wiki engine. Johannes Berg was administering the server and MoinMoin. Johannes was also the main PasDoc developer for some time, he restarted the PasDoc project on SourceForge, so he really deserves a thousand thanks!:) Two independent reasons pushed us to switch from MoinMoin to a GitHub wiki: 1. The MoinMoin engine started to be somewhat problematic on the server, eating too much CPU for too long, on some occasions. So, Johannes decided it's time to move away from MoinMoin. 2. At around the same time, Michalis became a fan of the Asciidoctor as a full-featured, but also super-easy to use, documentation format. And I realized that we could use Asciidoctor to generate offline PasDoc documentation in the future, if we use the GitHub wiki. Two killer features of GitHub wiki for us: - GitHub wiki allows to host the pages in the Asciidoctor format. So we can have online (wiki) and offline documentation generated from the same Asciidoctor sources, without any lossy conversions along the way. - GitHub wiki can be cloned and modified as a regular Git repository. This allows to do a lot of things comfortably. You can get the Asciidoctor files, run asciidoctor-pdf on them, and trivially easy get a PDF with PasDoc manual. So with a simple script, we may get a sleek PasDoc offline manual, in HTML and PDF. It's not done yet, but I think it will be trivially easy, whenever I'll find a time to attack this:) Enjoy! P.S. Who remembered that we have a "Star Wars" logo on the https://github.com/michaliskambi/pasdoc/wiki/PreformattedTag page?:) Regards, Michalis |