search

atheme / atheme-contrib-modules

Community-supported modules for Atheme
https://atheme.github.io/
Other
33 stars 39 forks source link

Improve config examples for contrib modules #39

Open KoraggKnightWolf opened 5 years ago

KoraggKnightWolf commented 5 years ago

Often times contrib modules have vague examples on how to include them in the config file. It is at times a guessing work, ideally comments would give a clear "this is a working example, add more to it" format (e.g. I personally found mlocktweaker very tricky to customize and even had a closed issue about it on the main repo). Also those that spawn more services could do with this as well, as "add a *Serv block to your config" may not be elaborate enough for everyone.

Regards,

Koragg

alyx commented 5 years ago

My immediate thought here is to include a contrib.conf.example which gets installed to $ATHEMEDIR/etc next to atheme.conf.example when --enable-contrib is enabled. This would keep atheme.conf clean from the misc. contrib clutter while also adding config support for these modules when requested.

Thoughts?

KoraggKnightWolf commented 5 years ago

Sorry for the late response, exam stuff and all <.<

Definitely a great idea I would say, and also with elaborate comments (where needed of course, I do find the ones in atheme.conf to suffice in most cases).

Also I believe it would have to be included somehow in the main atheme.conf ? If yes, that must also be added (what if it includes contrib.conf.example even if it does not exist? If that does not break stuff, might be the easiest way to implement that).

Regards

Koragg

alyx commented 5 years ago

That's what I was thinking; have a commented include in atheme.conf or something along those lines. @aaronmdjones brought up a good point on IRC as to how flexible Atheme's config handler is which I still need to evaluate but I believe this should be the best direction.