On Thu, Apr 2, 2015 at 11:11 AM, Carsten Haitzler <ras...@rasterman.com> wrote: > On Wed, 1 Apr 2015 22:49:15 -0700 Jeff Grimshaw <jeffrey.w.grims...@gmail.com> > said: > >> On Wed, Apr 1, 2015 at 8:21 PM, Carsten Haitzler <ras...@rasterman.com> >> wrote: >> >> > On Wed, 01 Apr 2015 22:19:53 +0100 Bertrand Jacquin <bertr...@jacquin.bzh> >> > said: >> > >> > > On 31/03/2015 23:46, Carsten Haitzler wrote: >> > > > On Tue, 31 Mar 2015 17:33:03 +0100 Bertrand Jacquin >> > > > <bertr...@jacquin.bzh> said: >> > > > >> > > >> Hey, >> > > >> >> > > >> On 31/03/2015 15:51, Stefan Schmidt wrote: >> > > >> >> > > >> > o Talk to beber to remove the old trac webservice to make sure we >> > have >> > > >> > less outdated information [assigned: Stefan] >> > > >> >> > > >> Do you want me to drop trac.e.org ? Do you want the content of >> > > >> trac.e.org be moved to phab (That is pain is the ass to do) ? Or to >> > > >> drop >> > > >> phab content already migrated from trac ? >> > > > >> > > > just drop it. :) no one is referring to the old content anymore :) and >> > > > chances >> > > > are the vast majority is out of date by now. >> > > >> > > trac is dead, long life to phabricator >> > >> > and while we are discussing web things... i've been messing with replacing >> > our >> > www custom php with a standard wiki that ... works for us. i've tried a >> > LOT of >> > them. a LOT. i finally found one that "works": dokuwiki. >> > https://www.dokuwiki.org/faq:pageprotect >> > >> > 1. it's in php (easy drop in for what we have). >> > 2. we can keep shot.php and update.php in the doku tree >> > 3. it is a plain file wiki (yay! no db!) >> > 4. it has a git back-end where the web content can be put in a separate git >> > repository! (more yay!) and wiki edits on www get committed, and commits >> > to the >> > git repo directly get pulled in every N minutes. >> > 5. its markdown is powerful enough for what we need >> > 6. it has code hilighting and more that is decent >> > 7. styling/templating/layout is flexible enough to make e.org look good. >> > 8. has actual users and authentication. (unlike some... errm gollum) >> > 9. doesn't seem to require any exotic php modules or extensions etc. >> > >> > so how do you want to do this? i have prepared a new www git tree (have >> > some >> > conflicts that will need to basically be thrown out). i have a test >> > www-content >> > git repo in my devs git repos. i will populate that at least with enough >> > initial content to make e.org usable again and then go from there. >> > server-side >> > this will need some config - eg like giving the www a devs account with an >> > ssh >> > priv key so the www server can commit to this www-content repo... i'd just >> > actually give the http user on e.org all of that (and if it is ever >> > abused/compromised we can nuke key access and revert any changes from that >> > user). >> > >> >> You might want to consider a dedicated git user for the wiki pages. There >> will come >> a day when you want to prevent or tightly control changes to some pages. >> API docs >> and other generated content come to mind. If the wiki pages are owned by >> someone >> other than httpd, you just take away the write rights at the file system >> level and it's >> done. > > that's what ... i said. it would need a dedicated git user account - like devs > we have now. it's the only sane way actually :) > >> https://www.dokuwiki.org/faq:pageprotect >> >> Also, separation of concerns, traceability, damage control, blah blah. > > meh. we have git for that :) > >> > any comments/input? >> > >> >> I really like this direction. Anything that will lower the barrier for new >> doc contributors >> can only help. >> >> How do you see API docs fitting in? I ask because since this thread >> <http://sourceforge.net/p/enlightenment/mailman/enlightenment-devel/thread/20141106160926.7238256c99509771c763be2b%40rasterman.com/#msg33009169>I've >> been looking >> at how other large projects handle docs and thinking about applying those >> ideas >> to e. I am moving in the direction of creating doc source files as Docbook >> XML and >> then generating whatever is needed from there. Some of the best projects >> I've looked at >> do it that way (PHP, FreeBSD) and I'm shamelessly stealing ideas from them. > > thinking generating markdown from .eo files and then having the markdown as > the > master. can already link+hilight tokens in code segments. just need to estend > dokuwiki to do it eveywhere ... somehow (and provide a list of tokens - ie > functions, enums, typedefs, classes etc.) >
I already told about it, but Dexy (http://dexy.it/docs/what-is-dexy.html) can do exactly that for you. You can define customized filters to extract and generate markdown from your Eo files, then run markdown on the files, push to dokuwiki, compile/run example code and integrate the output in your doc, etc... It is *extremely* flexible and we *do* need a flexible solution, right? We want our own documentation generation toolchain... Aside node, I really prefer AsciiDoc to Markdown as markup language. You'd get much happier with it if you had to write a full-blown user guide for example. AsciiDoc can execute filters too, and integrate auto-generated content in the output. Lionel >> > -- >> > ------------- Codito, ergo sum - "I code, therefore I am" -------------- >> > The Rasterman (Carsten Haitzler) ras...@rasterman.com >> > >> > >> > >> > ------------------------------------------------------------------------------ >> > Dive into the World of Parallel Programming The Go Parallel Website, >> > sponsored >> > by Intel and developed in partnership with Slashdot Media, is your hub for >> > all >> > things parallel software development, from weekly thought leadership blogs >> > to >> > news, videos, case studies, tutorials and more. Take a look and join the >> > conversation now. http://goparallel.sourceforge.net/ >> > _______________________________________________ >> > enlightenment-devel mailing list >> > enlightenment-devel@lists.sourceforge.net >> > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel >> > >> >> >> >> -- >> -- Jeff Grimshaw >> ------------------------------------------------------------------------------ >> Dive into the World of Parallel Programming The Go Parallel Website, >> sponsored >> by Intel and developed in partnership with Slashdot Media, is your hub for >> all >> things parallel software development, from weekly thought leadership blogs to >> news, videos, case studies, tutorials and more. Take a look and join the >> conversation now. http://goparallel.sourceforge.net/ >> _______________________________________________ >> enlightenment-devel mailing list >> enlightenment-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel >> > > > -- > ------------- Codito, ergo sum - "I code, therefore I am" -------------- > The Rasterman (Carsten Haitzler) ras...@rasterman.com > > > ------------------------------------------------------------------------------ > Dive into the World of Parallel Programming The Go Parallel Website, sponsored > by Intel and developed in partnership with Slashdot Media, is your hub for all > things parallel software development, from weekly thought leadership blogs to > news, videos, case studies, tutorials and more. Take a look and join the > conversation now. http://goparallel.sourceforge.net/ > _______________________________________________ > enlightenment-devel mailing list > enlightenment-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel ------------------------------------------------------------------------------ Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
