Create Essential DOC Structure for AAF

Issue-ID: AAF-328
Change-Id: I9508611149405bd95d0d1bf2ebe1e0ed37ba333b
Signed-off-by: Instrumental <jonathan.gathman@att.com>

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644 (file)
index 0000000..965350d
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,5 @@
+/_static/
+/etc/
+/.tox/
+/conf.py
+/tox.ini

diff --git a/docs/aaf-object-model.jpg b/docs/images/aaf-object-model.jpg
similarity index 100%
rename from docs/aaf-object-model.jpg
rename to docs/images/aaf-object-model.jpg

diff --git a/docs/index.rst b/docs/index.rst
index 0cbac00..ee4eef0 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,16 +13,14 @@ This is a critical function for Cloud environments, as Services need to be able
 To be effective during a computer transaction, Security must not only be secure, but very fast. Given that each transaction must be checked and validated for Authorization and Authentication, it is critical that all elements on this path perform optimally.
 
 
+Sections
+++++++++
 
 .. toctree::
-   :maxdepth: 1
-   
-   architecture/architecture.rst
-   Bootstrapping-AAF-Components/Bootstrapping-AAF-Components.rst
-   configuration/configuration.rst
-   Installation/installation.rst
-   logging/logging.rst
-   release-notes/release-notes.rst
+   :maxdepth: 2
+   :glob:
+
+   sections/*
    
    
 Introduction
@@ -31,7 +29,7 @@ AAF contains some elements of Role Based Authorization, but includes Attribute B
 
 |image0|
 
-.. |image0| image:: aaf-object-model.jpg
+.. |image0| image:: images/aaf-object-model.jpg
    :height: 600px
    :width: 800px
 

diff --git a/docs/architecture/aaf-cm.png b/docs/sections/architecture/aaf-cm.png
similarity index 100%
rename from docs/architecture/aaf-cm.png
rename to docs/sections/architecture/aaf-cm.png

diff --git a/docs/architecture/aaf-object-model.jpg b/docs/sections/architecture/aaf-object-model.jpg
similarity index 100%
rename from docs/architecture/aaf-object-model.jpg
rename to docs/sections/architecture/aaf-object-model.jpg

diff --git a/docs/architecture/architecture.rst b/docs/sections/architecture/aaf_architecture.rst
similarity index 98%
rename from docs/architecture/architecture.rst
rename to docs/sections/architecture/aaf_architecture.rst
index f9efd50..6e52288 100644 (file)
--- a/docs/architecture/architecture.rst
+++ b/docs/sections/architecture/aaf_architecture.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Architecture
-============
+AAF Architecture
+================
 AAF is designed to cover Fine-Grained Authorization, meaning that the Authorizations provided are able to used an Application’s detailed authorizations, such as whether a user may be on a particular page, or has access to a particular Pub-SUB topic controlled within the App.
 
 This is a critical function for Cloud environments, as Services need to be able to be installed and running in a very short time, and should not be encumbered with local configurations of Users, Permissions and Passwords.

diff --git a/docs/sections/architecture/security.rst b/docs/sections/architecture/security.rst
new file mode 100644 (file)
index 0000000..fd10dc9
--- /dev/null
+++ b/docs/sections/architecture/security.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+Security Architecture
+=====================
+Communicating
+-------------
+When one compute process needs to communicate to another, it does so with networking.
+
+The service side is always compute process, but the client can be of two types:
+ - People (via browser, or perhaps command line tool)
+ - Compute process talking to another computer process.
+
+Thus, the essential building blocks of any networked system is made up of 
+
+
+In larger systems, it is atypical 
+
+Communicating *Securely*
+------------------------
+Whenever two processing entities exist that need to communicate securely, it is *essential* that 
+ - The communications between the two are encrypted
+ - The identities of the caller and callee are established (authentication)
+ - The caller must be allowed to do what it is asking to do (authorization)
+
+
+
+

diff --git a/docs/configuration/configuration.rst b/docs/sections/configuration/client.rst
similarity index 77%
rename from docs/configuration/configuration.rst
rename to docs/sections/configuration/client.rst
index 37c8630..935fd27 100644 (file)
--- a/docs/configuration/configuration.rst
+++ b/docs/sections/configuration/client.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Configuration
-=============
+Client Configuration
+====================
 
 | 
 |

diff --git a/docs/sections/configuration/service.rst b/docs/sections/configuration/service.rst
new file mode 100644 (file)
index 0000000..92ee69b
--- /dev/null
+++ b/docs/sections/configuration/service.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Service Configuration
+=====================
+
+| 
+|

diff --git a/docs/sections/index.rst b/docs/sections/index.rst
new file mode 100644 (file)
index 0000000..88c1db9
--- /dev/null
+++ b/docs/sections/index.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+Architecture
+============
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   architecture/*
+
+Installation
+==============
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   installation/*
+
+Configuration
+=============
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   configuration/*
+

diff --git a/docs/Bootstrapping-AAF-Components/Bootstrapping-AAF-Components.rst b/docs/sections/installation/Bootstrapping-AAF-Components.rst
similarity index 100%
rename from docs/Bootstrapping-AAF-Components/Bootstrapping-AAF-Components.rst
rename to docs/sections/installation/Bootstrapping-AAF-Components.rst

diff --git a/docs/Installation/Installation.rst b/docs/sections/installation/Installation.rst
similarity index 100%
rename from docs/Installation/Installation.rst
rename to docs/sections/installation/Installation.rst

diff --git a/docs/sections/installation/fromsource.rst b/docs/sections/installation/fromsource.rst
new file mode 100644 (file)
index 0000000..6586ff5
--- /dev/null
+++ b/docs/sections/installation/fromsource.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+AAF From Source Code
+====================
+

diff --git a/docs/sections/installation/standalone.rst b/docs/sections/installation/standalone.rst
new file mode 100644 (file)
index 0000000..5c8cb65
--- /dev/null
+++ b/docs/sections/installation/standalone.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+
+Standalone Java Installation
+============================
+

diff --git a/docs/logging/logging.rst b/docs/sections/logging.rst
similarity index 100%
rename from docs/logging/logging.rst
rename to docs/sections/logging.rst

diff --git a/docs/release-notes/release-notes.rst b/docs/sections/release-notes.rst
similarity index 100%
rename from docs/release-notes/release-notes.rst
rename to docs/sections/release-notes.rst