well, if they are editing the code, modifying or adding something in the /doc
directory of the tree they are already working on should be a straightforward
thing for them to understand.
note that I am also guilty of submitting code without docs, it's such an easy
trap to fall into.
David Lang
On Sun, 15 Dec 2013, Otis Gospodnetic wrote:
Hi,
When people contribute it's perfectly OK to ask for a *bit* of
documentation.... but yeah, where does that documentation go? Is there a
Wiki (it's part of Github service, btw.) or some other easy-to-spot,
easy-to-edit place where things are documented?
Otis
--
Performance Monitoring * Log Analytics * Search Analytics
Solr & Elasticsearch Support * http://sematext.com/
On Sat, Dec 14, 2013 at 2:32 PM, Pavel Levshin <[email protected]> wrote:
14.12.2013 23:18, Rainer Gerhards:
Well, in practice I almost never received doc together with a code
contribution. ..
I can tell you that, at least partly, this is because there is no "how to
document your module/feature" guide. It is hard to write a document when
you do not know how to do it properly. There are other reasons, too.
For the doc project, first document should be "How to document"...
--
Pavel Levshin
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad
of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you
DON'T LIKE THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE
THAT.
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE
THAT.
