More docs! w/ some emphasis on "reports" section
This commit is contained in:
parent
2072e41e19
commit
da9823324d
38 changed files with 358 additions and 71 deletions
11
docs/base/cron.rst
Normal file
11
docs/base/cron.rst
Normal file
|
@ -0,0 +1,11 @@
|
|||
|
||||
Scheduled Tasks
|
||||
===============
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Luigi
|
||||
-----
|
||||
|
||||
TODO
|
|
@ -1,53 +0,0 @@
|
|||
|
||||
Sending Email
|
||||
=============
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Postfix Setup
|
||||
-------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Types of Emails
|
||||
---------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Configuring SMTP
|
||||
----------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Configuring Recipients etc.
|
||||
---------------------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Customizing Templates
|
||||
---------------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
How to programmatically send email
|
||||
----------------------------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Nod to email via error logging
|
||||
------------------------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Handling Email Bounces
|
||||
----------------------
|
||||
|
||||
TODO
|
6
docs/base/email/bounces.rst
Normal file
6
docs/base/email/bounces.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
========================
|
||||
Handling Email Bounces
|
||||
========================
|
||||
|
||||
TODO
|
5
docs/base/email/code.rst
Normal file
5
docs/base/email/code.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Programmatically Sending Email
|
||||
------------------------------
|
||||
|
||||
TODO
|
16
docs/base/email/config.rst
Normal file
16
docs/base/email/config.rst
Normal file
|
@ -0,0 +1,16 @@
|
|||
|
||||
Rattail Configuration
|
||||
=====================
|
||||
|
||||
TODO
|
||||
|
||||
Configuring SMTP
|
||||
----------------
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
Configuring Recipients etc.
|
||||
---------------------------
|
||||
|
||||
TODO
|
8
docs/base/email/dev.rst
Normal file
8
docs/base/email/dev.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
|
||||
----------------------------
|
||||
Development Considerations
|
||||
----------------------------
|
||||
|
||||
TODO
|
||||
|
||||
* aka. how not to send unwanted/test emails to staff or public!
|
6
docs/base/email/handler.rst
Normal file
6
docs/base/email/handler.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
===============
|
||||
Email Handler
|
||||
===============
|
||||
|
||||
TODO
|
18
docs/base/email/index.rst
Normal file
18
docs/base/email/index.rst
Normal file
|
@ -0,0 +1,18 @@
|
|||
|
||||
Sending Email
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
overview
|
||||
postfix
|
||||
system
|
||||
logging
|
||||
config
|
||||
templates
|
||||
code
|
||||
handler
|
||||
dev
|
||||
bounces
|
6
docs/base/email/logging.rst
Normal file
6
docs/base/email/logging.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
================
|
||||
Logging to Email
|
||||
================
|
||||
|
||||
TODO
|
24
docs/base/email/overview.rst
Normal file
24
docs/base/email/overview.rst
Normal file
|
@ -0,0 +1,24 @@
|
|||
|
||||
==========
|
||||
Overview
|
||||
==========
|
||||
|
||||
This manual is primarily concerned with 3 "types" of email:
|
||||
|
||||
* emails sent by the underlying system
|
||||
* emails sent via Python logging mechanism
|
||||
* emails sent explicitly by a Poser/Rattail app
|
||||
|
||||
The first, "emails sent by the underlying system" refers primarily to emails
|
||||
sent by the ``cron`` daemon. See :doc:`system` for more about those.
|
||||
|
||||
The second, "emails sent via Python logging mechanism" is covered in
|
||||
:doc:`logging`.
|
||||
|
||||
The third, "emails sent explicitly by a Poser/Rattail app" is the primary
|
||||
motivation behind this section of the manual. In particular see the sections
|
||||
about :doc:`config`, :doc:`templates` and :doc:`code`.
|
||||
|
||||
Finally, if you're sending email to the public, it may be helpful to detect
|
||||
bounces and e.g. flag an address as invalid if it triggers a bounce. See
|
||||
:doc:`bounces` for more on that.
|
5
docs/base/email/postfix.rst
Normal file
5
docs/base/email/postfix.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Postfix Setup
|
||||
=============
|
||||
|
||||
TODO
|
5
docs/base/email/system.rst
Normal file
5
docs/base/email/system.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
System Emails
|
||||
=============
|
||||
|
||||
TODO
|
6
docs/base/email/templates.rst
Normal file
6
docs/base/email/templates.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
=======================
|
||||
Customizing Templates
|
||||
=======================
|
||||
|
||||
TODO
|
|
@ -3,3 +3,5 @@ App Handlers
|
|||
============
|
||||
|
||||
TODO
|
||||
|
||||
* Report Handler
|
||||
|
|
|
@ -13,7 +13,9 @@ Base Layer
|
|||
config/index
|
||||
commands
|
||||
scripts
|
||||
email
|
||||
email/index
|
||||
cron
|
||||
supervisor
|
||||
filemon
|
||||
upgrades
|
||||
handlers
|
||||
|
|
6
docs/base/upgrades.rst
Normal file
6
docs/base/upgrades.rst
Normal file
|
@ -0,0 +1,6 @@
|
|||
|
||||
==============
|
||||
App Upgrades
|
||||
==============
|
||||
|
||||
TODO
|
Loading…
Add table
Add a link
Reference in a new issue