Rodolfo,
On Wed, Feb 18, 2009 at 11:34 AM, Rodolfo S. Carvalho <[email protected]
> wrote:
> Hi folks!
>
> Some time ago we started a discussion about documentation, and it was
> not so clearly about what we would do. I'm here to propose some things
> to get the work of documentation started.
> Umit needs documentation, that's a fact. And we need in both ways:
>
> - User documentation, to help user for using all features of umit
> - Developer documentation, to help new income developers to understand
> code, and also plugin developers to understand the Umit API.
>
> User documentation has priority above developer documentation, I
> think. But I also think we need both well-formed and following the
> same format, to make umit documentation a standard.
>
> I suggest the creation of a "docs" branch to start to write
> documentation, and convert the old docs to the new format. I also
> suggest we use sphinx to generate both user and dev documentation, to
> make a format standard.
>
How easy and fast convert actually user documentation to sphinx?
What's the advantage? Actually documentation it's very bad. I really don't
like it. Could you have a nice look, and a nice usability navigation at
documentation?
It's what matter IMHO. And someone would be put some effort on write it?
I'm in.
>
> I'd like to know your opinion about this, and I'd like to guide this
> thread to know who wants to make what. We need to put some effort on
> documentation in order to release the 1.0 version. We need each other
> to make Umit continue growing.
>
> I would also like to thank all effort spent with branches integration.
> You are doing a great job, and giving your hand to Umit when Umit is
> needing you. I'm proud of participating on Umit, I'm proud to have you
> as project colleages, and I want do be prouder and prouder.
>
> Let's make Umit the greatest network admin tool in the world!
> --
> Rodolfo Carvalho
> Web Developer
> [email protected]
>
>
> ------------------------------------------------------------------------------
> Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco,
> CA
> -OSBC tackles the biggest issue in open source: Open Sourcing the
> Enterprise
> -Strategies to boost innovation and cut costs with open source
> participation
> -Receive a $600 discount off the registration fee with the source code:
> SFAD
> http://p.sf.net/sfu/XcvMzF8H
> _______________________________________________
> Umit-devel mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/umit-devel
>
Cheers!
--
Luís A. Bastião Silva
------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Umit-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/umit-devel
