hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
I agree. I suggested also setting up a forum to roundcube@gmail.com. But im not sure if anybody checks that mailbox or not. There needs to be something to help with communication.
Regards
On 11/29/05, Tobias Witek tobi-wan-kinobi@gmx.net wrote:
hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.1 (GNU/Linux)
iD8DBQBDjBewKrRKwszAOdwRArHLAJoCN/e4XF3FCpe+kv6zohvy7CJ1mwCg2c+x Y1CWcqGit+tnDHQ2aTvkSO8= =X9/Z -----END PGP SIGNATURE-----
Hi Tobias,
All you described is a must-have for RoundCube and we're are working on a new wiki-based website which will provide the basic functionality to publish all these information. The more painful part will be to write all the docs but I guess we already have a lot of texts from the mailing list and from other sites describing the installation of RoundCube. I hope that we can come up with this soon but time is rare at the moment.
Regards, Thomas
Tobias Witek wrote:
hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
This mailbox is read but I can not answer every message since there are dozens each day... We decided to use the mailing list (more lists are coming up once) for communication and have a Trac system for bugs, feature requests, svn and roadmap planning.
Regards, Thomas
A Stableford wrote:
I agree. I suggested also setting up a forum to roundcube@gmail.com mailto:roundcube@gmail.com. But im not sure if anybody checks that mailbox or not. There needs to be something to help with communication.
Regards
On 11/29/05, *Tobias Witek* <tobi-wan-kinobi@gmx.net mailto:tobi-wan-kinobi@gmx.net> wrote:
hi everyone, it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think). may i suggest the introduction of a wiki for roundcube-related issues? i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit! and users can a) get some initial info on how to use roundcube b) browse FAQs any comments? best regards, t
2005/11/29, Thomas Bruederli roundcube@gmail.com:
The more painful part will be to write all the docs but I guess we already have a lot of texts from the mailing list and from other sites describing the installation of RoundCube. I hope that we can come up with this soon but time is rare at the moment.
That "painful part" would be a pleasure for many non-developers (as myself). It would be good if developers can develope and other users do support and documentation.
-- Andres Jimenez
On Tue, 29 Nov 2005 09:56:16 +0100, Tobias Witek tobi-wan-kinobi@gmx.net wrote:
hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
Of course, it'd be a boon to the project, plus relieve some of the tech support queries that keep popping up on the dev- list that ppl have complained about. I've used MediaWiki at jobs, and it's very easy to setup. Keeping it open for all registered users would be the way to go (save for the front page) IMHO. I used to update the Hula Project wiki and it was a great resource (currently hard to navigate...)
So what do you say Thomas? http://wiki.roundcube.net/ ? Would you need someone else to setup the Wiki? I'm not a web designer, but find the default Media Wiki fine for starters.
P
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
On Tue, 29 Nov 2005 10:14:08 +0100, Thomas Bruederli roundcube@gmail.com wrote:
Hi Tobias,
All you described is a must-have for RoundCube and we're are working on a new wiki-based website which will provide the basic functionality to publish all these information. The more painful part will be to write all the docs but I guess we already have a lot of texts from the mailing list and from other sites describing the installation of RoundCube. I hope that we can come up with this soon but time is rare at the moment.
Thomas Once the Wiki is up we'll (us on the list and RC users) will flesh out a framework for the docs, and then fill in the blanks. Ideally users would be better at the docs since they're coming at it from a user perspective, whereas you should keep on coding ;) and look over our docs for completeness. I hear ya on the free time, but thank you for what you've done for us. Now it's time for us to give back. Also I've used Trac on the Typo project, and it's a nice wiki/bug reporting app...I like it.
So, let me/us know if we can help in any way.
P
Regards, Thomas
Tobias Witek wrote:
hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
i'd have opted for edgewall's traq, which looks seriously nice (which fits with roundcube), but that's beside the point, 'cause it is one of those decisions where thomas has to have the last say :-)
as for adding to the docus: i'd be happy to share my experiences on a debian sarge postfix/courier-imap (using a virtualtable) with others, and a wiki would be quite the right place. if we can gather up enough sample-setups, it will be much easier for someone to reconstruct what went wrong (plus, we'll have a central focussing point for what _can_ go wrong).
Of course, it'd be a boon to the project, plus relieve some of the tech support queries that keep popping up on the dev- list that ppl have complained about. I've used MediaWiki at jobs, and it's very easy to setup. Keeping it open for all registered users would be the way to go (save for the front page) IMHO. I used to update the Hula Project wiki and it was a great resource (currently hard to navigate...)
So what do you say Thomas? http://wiki.roundcube.net/ ? Would you need someone else to setup the Wiki? I'm not a web designer, but find the default Media Wiki fine for starters.
P
Hi Phil,
Thanks very much for your offer to help. There's already somebody working on the installation of Trac (www.edgewall.com/trac/) but we still need to do some configuration of the bug tracker and some styling work.
I'll drop a message when it's ready and then I'd be happy to see the content growing...
Regards, Thomas
phil wrote:
On Tue, 29 Nov 2005 09:56:16 +0100, Tobias Witek tobi-wan-kinobi@gmx.net wrote:
hi everyone,
it seems that documentation (both for the user and for the developer) is rather small (no wonder, regarding the youth of roundcube, right now features are more important, i think).
may i suggest the introduction of a wiki for roundcube-related issues?
Of course, it'd be a boon to the project, plus relieve some of the tech support queries that keep popping up on the dev- list that ppl have complained about. I've used MediaWiki at jobs, and it's very easy to setup. Keeping it open for all registered users would be the way to go (save for the front page) IMHO. I used to update the Hula Project wiki and it was a great resource (currently hard to navigate...)
So what do you say Thomas? http://wiki.roundcube.net/ ? Would you need someone else to setup the Wiki? I'm not a web designer, but find the default Media Wiki fine for starters.
P
i'm thinking about it as something where developers can a) describe their modules b) agree on a coding convention (very important, in my opinion) c) sketch an overall frame of how roundcube's pieces fit and act together d) get a quick introduction into installing it (with configs "known to work" and ones that cause problems and how to circumvent them) e) ? f) profit!
and users can a) get some initial info on how to use roundcube b) browse FAQs
any comments?
best regards,
t
On Tuesday 29 November 2005 10:02, Thomas Bruederli wrote:
Hi Phil,
Thanks very much for your offer to help. There's already somebody working on the installation of Trac (www.edgewall.com/trac/) but we still need to do some configuration of the bug tracker and some styling work.
The Trac software includes a wiki. Perhaps we should use that wiki instead of setting up a separate one. Of course, it may not be bad to use the Trac wiki for development needs, and set up another wiki for end user documentation.