[OpenSER-Devel] documentation effort

[Edson]

Hi...

 

I get contact with Michiel on Friday and he told that he will be back on
March, 4th. 'til there I'll follow with the 'clean-up' that you proposed
(dead/unused code on README files).

 

As soon as the list is ready, I'll post all changes that I made so that the
developers can make a revision and commit or discuss it.

 

Just as an idea: I'd say that all developers (with SVN access, maybe) should
also subscribe to this new list, so that they also be aware on what we do.

Edson

  _____  

From: Henning Westerholt [mailto:henning.westerholt at 1und1.de] 
Sent: segunda-feira, 25 de fevereiro de 2008 09:57
To: devel at lists.openser.org; Edson
Cc: Michiel ten Hagen
Subject: Re: [OpenSER-Devel] documentation effort

 

On Friday 22 February 2008, Michiel ten Hagen wrote:

> During the IRC meetings I proposed to take on some of the work on

> improving the documentation.

> 

> For this I recommend the following:

> There already is lots of documentation on openser (and SER) distributed

> on the web and also the openser wiki does contain lots information but

> apparently this is not found by new users. A 'official openser guide'

> would be the appropriate solution for this, this way a single

> consistent source of information for new users is available.

> [..]

Hi Michiel,

having an 'openser guide' would be a really great thing. I agree, all
existing documentation on openser.org should be consolidated in one place.

> Its preferable to create the guide using DocBook XML and svn with a

> small team. MoinMoin supports wiki <-> docbook conversions, we could use

> that or create some XSLT ourselves. Using a DocBook -> wiki workflow

> allows web users to pinpoint mistakes or make small additions but leave

> the team to create a consistent document.

Well, we're using dokuwiki at the moment, and not MoinMoin. There exists
also a xslt docbook plugin for this wiki, but this is not that maintained
and performant i think. If we have a guide then we could just place it on
the webserver and link from the wiki. But these are details, no need to
discuss this now as long as we don't have a guide at all. ;-)

> Next the guide other improvements such as a faq are usefull but I

> suggest to focus on a guide.

> 

> Tasks

> - Create a single point of entry for documentation

> - Create an openser-doc mailing list

> - Create an separate doc tree in svn

> - Create a small documentation team

> - Create an 'official openser guide'

To the tasks:

I think we should start with the mailling list. Bogdan or Daniel, perhaps
one of you could create the 'openser-docs' list?

Forming a small team sounds good. Edson already contacted me last week, he
probably already want to join this effort. Perhaps sending an announcement
to the user list will also help to get some people joining this project.
Please let me know if there is something i could do to help you in getting
this started.

You'll will probably need svn access, perhaps we can discuss this after the
list has been setup and the first steps in toward the guide has been taken.

> I will be busy the rest of the month but after that I am willing to work

> on the procedures and start with a basic guide.

Great, i'm looking forward to this.

Cheers,

Henning

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.openser.org/pipermail/devel/attachments/20080225/30c4fe97/attachment.htm