On Tue, Jan 13, 2009 at 9:15 AM, Johan Sørensen <[email protected]> wrote: > > I just push my git-wikis branch to the mainline repository. In a > nutshell it's a wiki for the project, where the contents are stored in > a special git repository. The wiki is editable by any user who is > logged into the site.
Cool. Funny thing, I just implemented something like this in a personal project of mine this last week. Except it's in python (Django) and not public yet. > I decided to have it project-wide, since it makes more sense that way > considering gitorious is about _project_ collaboration. I also decided > against having it in a blessed branch of the mainline repository since > that feels a bit intrusive and not at least more painful > authentication wise. Personally, I don't care for this approach. But then I'm not following Gitorious' model of multiple repos per project. I went with something similar to github or bitbucket. But then I'm not going for providing a hosting service for public use either. The way I did it is that each repo (or possibly each branch in the future) has it's docs/wiki stored in a ``docs/`` directory within the same branch as the code. That way, as long as the dev keeps the docs up-to-date with his code, the docs will always match the code in that branch/repo, If another dev working in a separate clone of the project adds a different/new feature, then s/he can keep that clone's docs updated. That way there's no question about which part of the docs correspond to which variation of the code. And if 2 are merged, then the docs are merged as well. No special repos or special branches which need to be maintained separately. And the docs are easily packaged up with the code for distribution. Of course, one thing I need to do (and haven't done yet) is allow the repo owner to define the name of the dir which holds the docs/wiki. Don't want to lock them into only one option. > somedays: > * selectable format (markdown/textile/wikidoc et al) This is a must-have IMO. > There's also a script/create_wikis that will create the magic wiki for > each registered project, and search through the master tree for a file > matching /readme(\..*)?/i as the initial content for the wiki home > page. > Personally, I think the README should be on the overview page. The wiki home page could either be a directory listing of the wiki's root, or the contents of ``index\..*`` depending on whether the index file exists or not. Actually the same could apply to any subdirectory as well. At least that's how I did it. Hey, it has worked for Apache for years. -- ---- Waylan Limberg [email protected] --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Gitorious" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/gitorious?hl=en -~----------~----~----~----~------~----~------~--~---
