feat: refactored-overhauled docs, first pass

fix:edgexfoundry#1151 reorg main menu bar and added main landing page; upgrade mkdocs; add switch to light/dark modes Signed-off-by: jpwhitemn <[email protected]>
jpwhitemn · Jul 21, 2023 · b85c81e · b85c81e
1 parent 804e1fb
commit b85c81e
Show file tree

Hide file tree

Showing 16 changed files with 559 additions and 464 deletions.
diff --git a/Dockerfile.docs b/Dockerfile.docs
@@ -18,7 +18,7 @@
 FROM python:3.10-slim
 
 RUN pip install mkdocs \
-    "mkdocs-material==8.5.8" \
+    "mkdocs-material==9.1.19" \
     "mkdocs-htmlproofer-plugin>=0.8" \
     "mkdocs-macros-plugin>=0.5" \
     "mkdocs-swagger-ui-tag" \

diff --git a/docs_src/about.md b/docs_src/about.md
diff --git a/docs_src/assets/stylesheets/branding.css b/docs_src/assets/stylesheets/branding.css
@@ -23,7 +23,3 @@
     --md-code-bg-color:                  hsla(0, 0%, 92.5%, 0.5);
     --md-code-fg-color:                  hsla(200, 18%, 26%, 1);
   }
-
-  .md-header, .md-tabs {
-    background-color: var(--md-accent-fg-color);
-  }
diff --git a/docs_src/assets/stylesheets/extra.css b/docs_src/assets/stylesheets/extra.css
@@ -0,0 +1,33 @@
+.home-nav-column {
+  float: left;
+  width: 23%;
+  padding: 0 10px;
+  border-top: 5px solid hsla(282,65%,19%,1);
+  margin: 5px 5px;
+}
+
+.home-nav-row {
+margin: 0 -5px;
+}
+
+.home-nav-row:after {
+content: "";
+display: table;
+clear: both;
+}
+
+.divider {
+  border-top: 3px solid hsla(282,65%,19%,1);
+  padding-bottom: 0px;
+}
+
+.home-nav-icons {
+  vertical-align: middle;
+  height: 50px;
+  width: 50px;
+  margin-right: 0px;
+}
+
+.md-header, .md-tabs {
+  background-color: hsla(282,65%,19%,1);
+}
diff --git a/docs_src/docker.png b/docs_src/docker.png
diff --git a/docs_src/index.md b/docs_src/index.md
diff --git a/docs_src/microservices/application/V3Migration.md b/docs_src/microservices/application/V3Migration.md
@@ -1,4 +1,4 @@
-# V3 Migration Guide
+# V3 Application Service Migration Guide
 
 ## Configuration
 

diff --git a/docs_src/microservices/device/Ch-DeviceServices.md b/docs_src/microservices/device/Ch-DeviceServices.md
@@ -1,4 +1,4 @@
-# Device Services Microservices
+# Device Services
 
 ![image](EdgeX_DeviceServices.png)
 

diff --git a/docs_src/microservices/device/V3Migration.md b/docs_src/microservices/device/V3Migration.md
@@ -1,4 +1,4 @@
-# V3 Migration Guide
+# V3 Device Service Migration Guide
 
 ## All Device Services
 

diff --git a/docs_src/microservices/support/Ch-SupportingServices.md b/docs_src/microservices/support/Ch-SupportingServices.md
@@ -1,4 +1,4 @@
-# Supporting Services Microservices
+# Supporting Services
 
 ![image](EdgeX_SupportingServices.png)
 

diff --git a/docs_src/run.png b/docs_src/run.png
diff --git a/docs_src/security/Ch-Security.md b/docs_src/security/Ch-Security.md
@@ -1,4 +1,4 @@
-# Security
+# Security Services
 
 ![image](./EdgeX_Security.png)
 

diff --git a/docs_src/sensor.png b/docs_src/sensor.png
diff --git a/docs_src/snappy.png b/docs_src/snappy.png
diff --git a/docs/versions.json → docs_src/versions.json b/docs/versions.json → docs_src/versions.json
diff --git a/mkdocs.yml b/mkdocs.yml