Re: About the Wiki

I agree with Pierre Henri. Having the wiki be an editable version of the
NHibernate docs would lower the bar for people contributing to the
documentation. This would be a good thing. A quick Google revealed
DocBookWiki, which is wiki software specifically designed to display and
edit DocBook online. Rather than bulk importing/exporting DocBook->HTML,
DocBookWiki does it on the fly and stores its content in DocBook format.

http://doc-book.sourceforge.net/homepage/

It sounds promising, but I've only read the intro page and not actually
tried it out.

Personally I think that:

http://docs.nhibernate.org

would be a lot easier to remember than:

http://www.hibernate.org/hib_docs/nhibernate/1.2/reference/en/html_single/

IMHO I think docs.nhibernate.org makes more sense than wiki.nhibernate.org.
Wiki is an implementation detail. Docs describes what it is.

James
--
James Kovacs, B.Sc., M.Sc., MCSD, MCT
Microsoft MVP - C# Architecture
http://www.jameskovacs.com
[email protected]
403-397-3177 (mobile)

On Fri, Jul 4, 2008 at 2:47 AM, Pierre Henri Kuaté <[email protected]> wrote:

> We had a wiki a while ago (Confluence IIRC), but after the merging with
> hibernate.org, most of its articles where integrated in the current
> documentation.
>
> There are basically two options to start using one again:
> - (Continue to) use the current Hibernate wiki. Yes, there is one :) But it
> doesn't contain much NHibernate material.
> - Install our own wiki at either nhibernate.sourceforge.net or
> wiki.nhibernate.org (that's where the old one was).
> As far as I am concerned each of these options have their pros and cons:
> Using the Hibernate wiki would allow a better integration of the
> documentation (one website with everything). Hosting the wiki separately
> would allow choosing the software we want...
>
> One of the main action aside for hosting the wiki is putting some content
> in it since an empty wiki can be quite intimidating. Also, it seems that
> many would like to have the same documentation they have in the reference in
> that wiki (so that they can quickly edit it). This will also require some
> work to port the DocBook version to the wiki and keep them in sync (ie: port
> the edits back to the DocBook version).
>
> Something that could ease and speed up that process would be to have a wiki
> that support import/export from/to DocBook. I quickly googled it and it
> seems that there are a few tools that could be used...
>
> Pierre Henri.
>
>
> --- On *Thu, 7/3/08, Jon Stelly <[email protected]>* wrote:
>
> From: Jon Stelly <[email protected]>
> Subject: Re: [NHibernate-development] Aligning with Hibernate versioning
> To: "the NHibernate development list" <
> [email protected]>
> Date: Thursday, July 3, 2008, 11:20 PM
>
> I'd like to second the wiki idea.  I think API-level documentation is
> great, and I wouldn't want to lose what's there in that CHM file but a Wiki
> where we could better capture some guidance, examples, etc... would go a
> long way to making NHibernate easier to learn for beginners.  I've also had
> the same thought "I'd like to expand on this description a bit" but I don't
> have the motivation to download source and submit a patch (call me lazy).
>
> On Wed, Jul 2, 2008 at 8:56 PM, Fabio Maulo <[email protected]> wrote:
>
>> 2008/7/2 Will Shaver <[email protected]>:
>>
>>> What we need is an actual Wikipedia style Wiki for docs. There have been
>>> multiple times while reading the documentation that I've thought, "that's
>>> wrong, and I would fix it right here if I could... but firing up an xml
>>> editor and re-compiling it is too much effort."
>>>
>>>
>>
>> Ok you and the community will have it ;)
>>
>> -------------------------------------------------------------------------
>> Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
>> Studies have shown that voting for your favorite open source project,
>> along with a healthy diet, reduces your potential for chronic lameness
>> and boredom. Vote Now at http://www.sourceforge.net/community/cca08
>> _______________________________________________
>> Nhibernate-development mailing list
>> [email protected]
>> https://lists.sourceforge.net/lists/listinfo/nhibernate-development
>>
>>
> -------------------------------------------------------------------------
> Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
> Studies have shown that voting for your favorite open source project,
> along with a healthy diet, reduces your potential for chronic lameness
> and boredom. Vote Now at http://www.sourceforge.net/community/cca08
>
> _______________________________________________
> Nhibernate-development mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/nhibernate-development
>
>
>
> -------------------------------------------------------------------------
> Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
> Studies have shown that voting for your favorite open source project,
> along with a healthy diet, reduces your potential for chronic lameness
> and boredom. Vote Now at http://www.sourceforge.net/community/cca08
> _______________________________________________
> Nhibernate-development mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/nhibernate-development
>
>

-------------------------------------------------------------------------
Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
Studies have shown that voting for your favorite open source project,
along with a healthy diet, reduces your potential for chronic lameness
and boredom. Vote Now at http://www.sourceforge.net/community/cca08

_______________________________________________
Nhibernate-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/nhibernate-development