Documentation Update

docs/pages/dev_notes.txt

@@ -4,17 +4,6 @@
  *
  * This page contains a series of notes intended to be beneficial for any contributors to AOSSL.
  *
- * ## Long Term Vision
- *
- * AOSSL was begun out of a need for blazing-fast, secure, and robust core services
- * within a larger architecture.  It looks to provide a developer kit which will decrease
- * overall time-to-market for these services, while allowing for maximum flexibility.
- *
- * The long-term vision of AOSSL is to ensure that this architecture is robust, secure,
- * and modular, and to continue to add functionality and drivers for major use-cases.
- * In addition, in future versions, AOSSL will look to become a full fledged framework,
- * rather than simply a collection of drivers.
- *
  * ## Generating Releases
  *
  * The release_gen.sh script is utilized to generate releases for various systems.
@@ -23,6 +12,11 @@
  * - the version of the release: we follow [semantic versioning](http://semver.org/)
  * - the location of the dependency script: current valid paths are linux/deb (uses apt-get) and linux/rhel (uses yum)
  *
+ * ## Security Notes
+ * Currently AOSSL components are unsecured.  Three critical security needs have been identified:
+ * - Consul 'Secret Store' using Hashicorp Vault as a backend.  Allow for secure storage of private config values.
+ * - ZMQ LibCurve encryption, using built-in security mechanisms of 0MQ to encrypt messages sent and decrypt messages recieved.
+ * - HTTPS Support, for securing HTTP Communications.  Further encryptions via HTTP would need to be handled by end user.
  *
  * \ref index "Go Home"
  */

docs/pages/main_page.txt

@@ -30,7 +30,11 @@
  * - \ref props "Properties File Parser"
  * - \ref http_client "HTTP Client"
  *
- * \section moreinfo More Information
- * - \ref tests "Library Tests"
+ * \section moreinfo Dependency Information
  * - \ref dependencies "Library Dependencies"
+ *
+ * \section contributing Contributing
+ * - \ref tests "Library Tests"
+ * - \ref devnotes "Developer Notes"
+ * - \ref vision "Vision"
  */

docs/pages/tests.txt

@@ -4,6 +4,10 @@
  *
  * AOSSL Uses Travis-CI for automated builds and tests, for full history please see the [Travis CI Homepage](https://travis-ci.org/AO-StreetArt/AOSharedServiceLibrary).
  *
+ * The current Travis configuration builds the central library, tests, and benchmarks.
+ *
+ * Then, Travis runs the below specified tests.  If you are adding tests to the library, they will need to be added to the .travis.yml file in order to be run automatically.  It does not automatically run the benchmarks.
+ *
  * ## Manually Executing Tests
  *
  * Once we follow the commands in the quickstart for building from source, we have a set of executables that end with "test" which run some basic tests on the libraries to ensure they function correctly.  Please note that the Redis, Couchbase, Consul, and Mongo tests will require an active server/agent for the respective service.

docs/pages/vision.txt

@@ -0,0 +1,15 @@
+/*! \page vision Vision
+ *
+ * # Long Term Vision
+ *
+ * AOSSL was begun out of a need for blazing-fast, secure, and robust core services
+ * within a larger architecture.  It looks to provide a developer kit which will decrease
+ * overall time-to-market for these services, while allowing for maximum flexibility.
+ *
+ * The long-term vision of AOSSL is to ensure that this architecture is robust, secure,
+ * and modular, and to continue to add functionality and drivers for major use-cases.
+ * In addition, in future versions, AOSSL will look to become a full fledged framework,
+ * rather than simply a collection of drivers.
+ *
+ * \ref index "Go Home"
+ */