[rs-commit] r141 - /rs-manual/trunk/src/site/xhtml5/architecture.xhtml5

[rs-commit at redwax.eu]

Author: minfrin at redwax.eu
Date: Tue Nov 12 00:38:12 2019
New Revision: 141

Log:
Add an architecture note on sensible errors.

Modified:
    rs-manual/trunk/src/site/xhtml5/architecture.xhtml5

Modified: rs-manual/trunk/src/site/xhtml5/architecture.xhtml5
==============================================================================
--- rs-manual/trunk/src/site/xhtml5/architecture.xhtml5	(original)
+++ rs-manual/trunk/src/site/xhtml5/architecture.xhtml5	Tue Nov 12 00:38:12 2019
@@ -195,6 +195,29 @@
           </div>
         </section>
 
+        <section>
+          <header>
+            <h3>Sensible Errors</h3>
+          </header>
+          <div class="content none">
+            <p>
+              All error paths must be handled, every error response must be unique,
+              and the errors themselves must be sensible.
+            </p>
+            <p>
+              Redwax Server returns most errors in the response to the caller, as
+              well as logging the errors with additional private information for the
+              administrator. This makes Redwax Server significantly easier to
+              troubleshoot without the need for administrator access to the underlying
+              server.
+            </p>
+            <p>
+              All errors are unique, such that there is always an unambiguous record
+              of how a particular module responded to a request.
+            </p>
+          </div>
+        </section>
+
       </div>
     </section>