Add example images and ReadTheDocs

- Added images with resulting vSphere views and commandline output from runs of the various examples - Added badge for ReadTheDocs page and removed images from README - Updated script warning prompt
GhostofGoes · May 8, 2017 · c1e6f4a · c1e6f4a
1 parent 70ff376
commit c1e6f4a
Show file tree

Hide file tree

Showing 41 changed files with 9 additions and 18 deletions.
diff --git a/README.rst b/README.rst
@@ -13,6 +13,10 @@
 .. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
    :alt: License
+.. image:: https://readthedocs.org/projects/adles/badge/?version=latest
+   :target: http://adles.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
 
 Overview
 ========
@@ -26,12 +30,6 @@ Automated Deployment of Lab Environments System (ADLES)
   time and effort, and alieviates the requirement of possessing advanced IT knowledge.
 
 
-.. image:: documentation/system-overview-diagram.png
-   :width: 40pt
-   :align: center
-   :alt: Overview of the system
-
-
 Getting started
 ===============
 
@@ -64,12 +62,6 @@ How to use:
    adles -d -s my-competition.yaml
 
 
-.. image:: documentation/usage-flowchart.png
-   :width: 40pt
-   :align: center
-   :alt: Usage flowchart
-
-
 System requirements
 ===================
 

diff --git a/adles/__init__.py b/adles/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-__version__ = "1.1.7"
+__version__ = "1.1.8"
 __author__ = "Christopher Goes"
 __email__ = "<[email protected]>"
 __license__ = "Apache 2.0"

diff --git a/adles/utils.py b/adles/utils.py
@@ -233,11 +233,10 @@ def _script_warning_prompt():
     return str(
         '***** YOU RUN THIS SCRIPT AT YOUR OWN RISK *****\n'
         '\n ** Help and Documentation **'
-        '\n* "<script>.py --help": flags, arguments, and usage'
-        '\n* "cat <script>.py": read the source code and see how it works'
-        '\n* "cd ./documentation && ls -la": show available documentation'
-        '\n+ Open an issue on the project GitHub: %s'
-        '\n+ Email the script author: %s'
+        '\n+ "<script> --help": flags, arguments, and usage'
+        '\n+ Read the latest documentation  : https://adles.readthedocs.io'
+        '\n+ Open an issue on GitHub        : %s'
+        '\n+ Email the script author        : %s'
         '\n' % (__url__, __email__))
 
 

diff --git a/documentation/Results and examples/cleanup-vms-competition.PNG b/documentation/Results and examples/cleanup-vms-competition.PNG
diff --git a/documentation/Results and examples/cleanup-vms-example.PNG b/documentation/Results and examples/cleanup-vms-example.PNG
diff --git a/...tation/Results and examples/competition-april-9-deployment-blue-team-folder.PNG b/...tation/Results and examples/competition-april-9-deployment-blue-team-folder.PNG
diff --git a/...ntation/Results and examples/competition-april-9-deployment-external-folder.PNG b/...ntation/Results and examples/competition-april-9-deployment-external-folder.PNG
diff --git a/...tation/Results and examples/competition-april-9-deployment-master-templates.PNG b/...tation/Results and examples/competition-april-9-deployment-master-templates.PNG
diff --git a/documentation/Results and examples/competition-april-9-deployment-part1.PNG b/documentation/Results and examples/competition-april-9-deployment-part1.PNG
diff --git a/documentation/Results and examples/competition-april-9-deployment-part1v2.png b/documentation/Results and examples/competition-april-9-deployment-part1v2.png
diff --git a/documentation/Results and examples/competition-april-9-deployment-part2.PNG b/documentation/Results and examples/competition-april-9-deployment-part2.PNG
diff --git a/documentation/Results and examples/competition-april-9-mastering.PNG b/documentation/Results and examples/competition-april-9-mastering.PNG
diff --git a/documentation/Results and examples/example-verbose-syntax-run.PNG b/documentation/Results and examples/example-verbose-syntax-run.PNG
diff --git a/documentation/Results and examples/example1.PNG b/documentation/Results and examples/example1.PNG
diff --git a/documentation/Results and examples/firewall-master-templates.PNG b/documentation/Results and examples/firewall-master-templates.PNG
diff --git a/documentation/Results and examples/firewall-mastering.PNG b/documentation/Results and examples/firewall-mastering.PNG
diff --git a/documentation/Results and examples/firewall-masters.PNG b/documentation/Results and examples/firewall-masters.PNG
diff --git a/documentation/Results and examples/firewall-vyos.PNG b/documentation/Results and examples/firewall-vyos.PNG
diff --git a/documentation/Results and examples/firewall-workstations.PNG b/documentation/Results and examples/firewall-workstations.PNG
diff --git a/documentation/Results and examples/firewalls-deployment.PNG b/documentation/Results and examples/firewalls-deployment.PNG
diff --git a/documentation/Results and examples/pentest-april-9-attacker.PNG b/documentation/Results and examples/pentest-april-9-attacker.PNG
diff --git a/documentation/Results and examples/pentest-april-9-exercise-router.PNG b/documentation/Results and examples/pentest-april-9-exercise-router.PNG
diff --git a/documentation/Results and examples/pentest-april-9-folder-structure.PNG b/documentation/Results and examples/pentest-april-9-folder-structure.PNG
diff --git a/documentation/Results and examples/pentest-april-9-master-folder.PNG b/documentation/Results and examples/pentest-april-9-master-folder.PNG
diff --git a/documentation/Results and examples/pentest-april-9-planted-phone.PNG b/documentation/Results and examples/pentest-april-9-planted-phone.PNG
diff --git a/documentation/Results and examples/pentest-april-9-router-template.PNG b/documentation/Results and examples/pentest-april-9-router-template.PNG
diff --git a/documentation/Results and examples/pentest-april-9-student-workstations-edit.PNG b/documentation/Results and examples/pentest-april-9-student-workstations-edit.PNG
diff --git a/documentation/Results and examples/pentest-april-9-student-workstations.PNG b/documentation/Results and examples/pentest-april-9-student-workstations.PNG
diff --git a/documentation/Results and examples/pentest-april-9-systems-edit.PNG b/documentation/Results and examples/pentest-april-9-systems-edit.PNG
diff --git a/documentation/Results and examples/pentest-april-9-systems.PNG b/documentation/Results and examples/pentest-april-9-systems.PNG
diff --git a/documentation/Results and examples/pentest-deployment-april-9.PNG b/documentation/Results and examples/pentest-deployment-april-9.PNG
diff --git a/documentation/Results and examples/pentest-mastering-april-9.PNG b/documentation/Results and examples/pentest-mastering-april-9.PNG
diff --git a/documentation/Results and examples/powershell-vsphere-info.PNG b/documentation/Results and examples/powershell-vsphere-info.PNG
diff --git a/documentation/Results and examples/spoofing-april-9-mastering.PNG b/documentation/Results and examples/spoofing-april-9-mastering.PNG
diff --git a/documentation/Results and examples/spoofing-deployment.PNG b/documentation/Results and examples/spoofing-deployment.PNG
diff --git a/documentation/Results and examples/spoofing-hidden.PNG b/documentation/Results and examples/spoofing-hidden.PNG
diff --git a/documentation/Results and examples/spoofing-masters.PNG b/documentation/Results and examples/spoofing-masters.PNG
diff --git a/documentation/Results and examples/spoofing-workstations.PNG b/documentation/Results and examples/spoofing-workstations.PNG
diff --git a/documentation/Results and examples/windows-installation.PNG b/documentation/Results and examples/windows-installation.PNG
diff --git a/documentation/Results and examples/windows-vsphere-info.PNG b/documentation/Results and examples/windows-vsphere-info.PNG
diff --git a/documentation/vsphere-vchierarchy-from-pyvmomi-community-samples-page.pdf b/documentation/vsphere-vchierarchy-from-pyvmomi-community-samples-page.pdf