fixed topics diagrams

.markdownlint.yaml

@@ -1,4 +1,5 @@
 MD013: false
 MD024: false
 MD033: false
+MD045: false
 MD046: false

docs/concepts.md

@@ -1,7 +1,8 @@
 # Concepts
 
-We’ll start with brief descriptions of KubeFox constituents and gradually drop
-deeper into detail.
+The following are brief descriptions of KubeFox constituents. For more details
+and tutorials on their use checkout additional documentation under
+[topics](../topics).
 
 ## Event
 

docs/topics/deployment_distillation.md

@@ -52,8 +52,8 @@ When the Order System is initially deployed (we'll call this the 'a'
 deployment), it will look like this in KubeFox (Figure 1):
 
 <figure markdown>
-  <img src="../diagrams/deployments/distillation/light/deployment_a(light).svg#only-light" width=100% height=100%>
-  <img src="../diagrams/deployments/distillation/dark/deployment_a(dark).svg#only-dark" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/light/deployment_a(light).svg#only-light" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/dark/deployment_a(dark).svg#only-dark" width=100% height=100%>
   <figcaption>Figure 1 - Initial Deployment [a]</figcaption>
 </figure>
 
@@ -69,8 +69,8 @@ Let's say that the user needs to make a change to the order-ui component. When
 System b is deployed, it will look as shown in Figure 2:
 
 <figure markdown>
-  <img src="../diagrams/deployments/distillation/light/deployment_b(light).svg#only-light" width=100% height=100%>
-  <img src="../diagrams/deployments/distillation/dark/deployment_b(dark).svg#only-dark" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/light/deployment_b(light).svg#only-light" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/dark/deployment_b(dark).svg#only-dark" width=100% height=100%>
   <figcaption>Figure 2 - Deployment [b] to change the order-ui component</figcaption>
 </figure>
 
@@ -85,8 +85,8 @@ component. Again, KubeFox checks the state of the System and deploys only
 api-srv[c]:
 
 <figure markdown>
-  <img src="../diagrams/deployments/distillation/light/deployment_c(light).svg#only-light" width=100% height=100%>
-  <img src="../diagrams/deployments/distillation/dark/deployment_c(dark).svg#only-dark" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/light/deployment_c(light).svg#only-light" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/dark/deployment_c(dark).svg#only-dark" width=100% height=100%>
   <figcaption>Figure 3 - Deployment [c] to change the api-srv component</figcaption>
 </figure>
 
@@ -103,8 +103,8 @@ In our final deployment [d], the user does a couple of things:
 When the System is deployed, it looks as shown in Figure 4:
 
 <figure markdown>
-  <img src="../diagrams/deployments/distillation/light/deployment_d(light).svg#only-light" width=100% height=100%>
-  <img src="../diagrams/deployments/distillation/dark/deployment_d(dark).svg#only-dark" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/light/deployment_d(light).svg#only-light" width=100% height=100%>
+  <img src="../../diagrams/deployments/distillation/dark/deployment_d(dark).svg#only-dark" width=100% height=100%>
   <figcaption>Figure 4 - Deployment [d] to add a component and modify order-ui</figcaption>
 </figure>
 

docs/topics/index.md

@@ -0,0 +1,3 @@
+# Overview
+
+TODO provide overview of what topics documents are trying to achieve.

docs/topics/telemetry.md

@@ -14,21 +14,21 @@ You can visualize the behavior of the entire System (all applications composing
 the Retail System) as shown in Figure 1:
 
 <figure markdown>
-  <img src="../diagrams/telemetry/telemetry_system.svg" width=100% height=100%>
+  <img src="../../diagrams/telemetry/telemetry_system.svg" width=100% height=100%>
   <figcaption>Figure 1 - Span-based telemetry for the entire System</figcaption>
 </figure>
 
 You can visualize behavior by Application (Figure 2) - for instance for the
 Fulfillment app:
 
 <figure markdown>
-  <img src="../diagrams/telemetry/telemetry_application.svg" width=100% height=100%>
+  <img src="../../diagrams/telemetry/telemetry_application.svg" width=100% height=100%>
   <figcaption>Figure 2 - Span-based telemetry for the Fulfillment App</figcaption>
 </figure>
 
 And you can visualize behavior by individual Component (Figure 3):
 
 <figure markdown>
-  <img src="../diagrams/telemetry/telemetry_component.svg" width=100% height=100%>
+  <img src="../../diagrams/telemetry/telemetry_component.svg" width=100% height=100%>
   <figcaption>Figure 3 - Span-based telemetry for the Web UI component of the Web UI App</figcaption>
 </figure>

docs/topics/versioned_deployments.md

@@ -12,8 +12,8 @@ Let’s start with a Retail System composed of 3 applications, a Web UI app, a
 Catalog app and a fulfillment app, as shown in Figure 1:
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/light/retail_system_composition_v1(light).svg#only-light" width=90% height=90%>
-  <img src="../diagrams/deployments/versioned/dark/retail_system_composition_v1(dark).svg#only-dark" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/light/retail_system_composition_v1(light).svg#only-light" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/dark/retail_system_composition_v1(dark).svg#only-dark" width=90% height=90%>
   <figcaption>Figure 1 - Composition of Version 1 of the Retail System</figcaption>
 </figure>
 
@@ -23,7 +23,7 @@ Service and Member Service components.  When the Retail System is deployed by
 KubeFox, the cluster will look like the diagram in Figure 2.  
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/retail_system_v1.svg" width=100% height=100%>
+  <img src="../../diagrams/deployments/versioned/retail_system_v1.svg" width=100% height=100%>
   <figcaption>Figure 2 - First Deployment of the Retail System</figcaption>
 </figure>
 
@@ -42,8 +42,8 @@ current example, if we update the Catalog Query component in the Catalog app,
 our Retail System will be composed of the components shown in Figure 3.
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/light/retail_system_composition_v2(light).svg#only-light" width=90% height=90%>
-  <img src="../diagrams/deployments/versioned/dark/retail_system_composition_v2(dark).svg#only-dark" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/light/retail_system_composition_v2(light).svg#only-light" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/dark/retail_system_composition_v2(dark).svg#only-dark" width=90% height=90%>
   <figcaption>Figure 3 - Composition of Version 2 of the Retail System</figcaption>
 </figure>
 
@@ -52,7 +52,7 @@ change within a System - whether an updated to a component, or addition of a
 component - will yield a new version of that System.
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/retail_system_v2.svg" width=100% height=100%>
+  <img src="../../diagrams/deployments/versioned/retail_system_v2.svg" width=100% height=100%>
   <figcaption>Figure 4 - Version 2 of the Retail System with the modified Catalog Query component</figcaption>
 </figure>
 
@@ -80,13 +80,13 @@ version 1 of the Retail System, so we only need version 2 of the Catalog Query
 component.  The component building blocks will be those shown in Figure 5.
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/light/retail_system_composition_v3(light).svg#only-light" width=90% height=90%>
-  <img src="../diagrams/deployments/versioned/dark/retail_system_composition_v3(dark).svg#only-dark" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/light/retail_system_composition_v3(light).svg#only-light" width=90% height=90%>
+  <img src="../../diagrams/deployments/versioned/dark/retail_system_composition_v3(dark).svg#only-dark" width=90% height=90%>
   <figcaption>Figure 5 - Composition of Version 3 of the Retail System</figcaption>
 </figure>
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/retail_system_v3.svg" width=100% height=100%>
+  <img src="../../diagrams/deployments/versioned/retail_system_v3.svg" width=100% height=100%>
   <figcaption>Figure 6 - Version 3 of the Retail System</figcaption>
 </figure>
 
@@ -99,7 +99,7 @@ component (thereby creating Version 4 of the Retail System), we can choose to
 deprecate the v1 version of Vendor Services (Figure 7).
 
 <figure markdown>
-  <img src="../diagrams/deployments/versioned/retail_system_v4.svg" width=100% height=100%>
+  <img src="../../diagrams/deployments/versioned/retail_system_v4.svg" width=100% height=100%>
   <figcaption>Figure 7 - Version 4 of the Retail System</figcaption>
 </figure>
 
@@ -116,7 +116,7 @@ Now is a good time to review KubeFox deployments and releases.
 
 <!-- <object
   id="color-change-svg"
-  data="../diagrams/deployments/dark/test.svg"
+  data="../../diagrams/deployments/dark/test.svg"
   type="image/svg+xml"
   >
  </object> -->

docs/topics/virtual_environments.md

@@ -19,7 +19,7 @@ critical in prod etc.  Environments enable us to build policy controls
 supporting these tenets. Figure 1 shows a typical dev environment.
 
 <figure markdown>
-  <img src="../diagrams/environments/typical_dev_environment.svg" width=100% height=100%>
+  <img src="../../diagrams/environments/typical_dev_environment.svg" width=100% height=100%>
   <figcaption>Figure 1 - A typical Dev environment</figcaption>
 </figure>
 
@@ -81,15 +81,15 @@ Polina can test her new code in Environment A, which is unique to her (Figure
 2):
 
 <figure markdown>
-  <img src="../diagrams/environments/polina_environment_a.svg" width=100% height=100%>
+  <img src="../../diagrams/environments/polina_environment_a.svg" width=100% height=100%>
   <figcaption>Figure 2 - Polina testing in environment A</figcaption>
 </figure>
 
 and then shift instantly to Environment B (Figure 3), perhaps to compare her
 changes with the prior version of software:
 
 <figure markdown>
-  <img src="../diagrams/environments/polina_environment_b.svg" width=100% height=100%>
+  <img src="../../diagrams/environments/polina_environment_b.svg" width=100% height=100%>
   <figcaption>Figure 3 - Polina testing in environment B</figcaption>
 </figure>
 
@@ -117,7 +117,7 @@ component of the Web UI app.  But KubeFox has distilled the deployment to only
 those unique versions of the Web UI component.
 
 <figure markdown>
-  <img src="../diagrams/environments/distilled_dev_environment.svg" width=100% height=100%>
+  <img src="../../diagrams/environments/distilled_dev_environment.svg" width=100% height=100%>
   <figcaption>Figure 4 - KubeFox Distilled Dev Environment</figcaption>
 </figure>
 
@@ -126,7 +126,7 @@ appear to be independent sandboxes with dedicated resources.  For instance, to
 Polina, the system appears as in Figure 5.
 
 <figure markdown>
-  <img src="../diagrams/environments/distilled_dev_environment.svg" width=100% height=100%>
+  <img src="../../diagrams/environments/distilled_dev_environment.svg" width=100% height=100%>
   <figcaption>Figure 5 - Polina's Dev Environment</figcaption>
 </figure>