Admin emails documentation

Admin emails documentation

[Thomas.J.Waldmann, 2013-09-19 09:44:51]

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst
File docs/admin/configure.rst (right):

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1294: * inform admins about code exceptions
code exceptions sounds strange. runtime exceptions?

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1302: mail_smarthost = "smtp.example.org:port"
no, this is mixing up things.

the hostname is now an example, but the "port" is a placeholder.

you rather should also give an example there and also tell about the default, if
it is not given. or show the default as example and tell it is the default.

like:
"smtp.example.org:25"  (or :587 for submission)

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1317: --------------
same amount of ----- as text above?

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1327: 
i see you have a logging configuration file example in this code review, but you
don't talk about this in the docs.

https://codereview.appspot.com/13457059/diff/1/docs/examples/config/logging/e...
File docs/examples/config/logging/email (right):

https://codereview.appspot.com/13457059/diff/1/docs/examples/config/logging/e...
docs/examples/config/logging/email:2: # List of admin emails, if left blank will
extract the list from wikiconfig ADMIN_EMAILS
can you point me to the place where you actually implemented this fallback?

https://codereview.appspot.com/13457059/diff/1/docs/examples/config/logging/e...
docs/examples/config/logging/email:12: emailloglevel = ERROR
looks like spacing is inconsistent. choose same style as other logging configs.

[ana.balica, 2013-09-19 12:49:34]

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst
File docs/admin/configure.rst (right):

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1327: 
On 2013/09/19 09:44:51, Thomas.J.Waldmann wrote:
> i see you have a logging configuration file example in this code review, but
you
> don't talk about this in the docs.

The files from examples/ folder are not generated with sphinx atm (at least when
i run sphinx-build i don't get those), so the reference :doc: doesn't link to
anything.

Are those examples going to be added to the index later?

https://codereview.appspot.com/13457059/diff/1/docs/examples/config/logging/e...
File docs/examples/config/logging/email (right):

https://codereview.appspot.com/13457059/diff/1/docs/examples/config/logging/e...
docs/examples/config/logging/email:2: # List of admin emails, if left blank will
extract the list from wikiconfig ADMIN_EMAILS
On 2013/09/19 09:44:51, Thomas.J.Waldmann wrote:
> can you point me to the place where you actually implemented this fallback?

sure
https://bitbucket.org/ana-balica/moin-2.0/src/337b8bb2c90337f7d4011f75f12c483...
line 207

[Thomas.J.Waldmann, 2013-09-22 10:09:54]

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst
File docs/admin/configure.rst (right):

https://codereview.appspot.com/13457059/diff/1/docs/admin/configure.rst#newco...
docs/admin/configure.rst:1327: 
> The files from examples/ folder are not generated with sphinx atm (at least
when
> i run sphinx-build i don't get those), so the reference :doc: doesn't link to
> anything.

Well, i rather meant talking about them, not linking them technically with
sphinx.

> Are those examples going to be added to the index later?

Maybe.

[Thomas.J.Waldmann, 2013-09-22 11:37:09]

https://codereview.appspot.com/13457059/diff/12001/docs/admin/configure.rst
File docs/admin/configure.rst (right):

https://codereview.appspot.com/13457059/diff/12001/docs/admin/configure.rst#n...
docs/admin/configure.rst:1329: Also you can check a sample configuration file
for Email logging.
Please also check the logging configuration example in docs/...