Enable social media previews (#21)

Author: kangasta

docs/assets/logo.svg

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to install and configure Docker and Docker Compose on Ubuntu running inside Windows Subsystem for Linux.
+---
+
 # Install Docker on Windows Subsystem for Linux
 
 If you do not already have Windows Subsystem for Linux (WSL) installed, see [Install Linux on Windows with WSL](https://docs.microsoft.com/en-us/windows/wsl/install) for instructions.

docs/examples/docker/docker-on-wsl/README.md

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to configure a Jenkins pipeline that deploys an simple hello-world application to a Kubernetes cluster.
+---
+
 # Deploy application to Kubernetes with Ansible
 
 This example contains a pipeline that deploys an simple hello-world application to a Kubernetes cluster.

docs/examples/jenkins/ansible-kubernetes/README.md

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to configure a Jenkins pipeline that creates pipelines with five different statuses into a new folder using Job DSL.
+---
+
 # Build status pipelines and Job DSL
 
 This example contains pipelines to produce builds with success, unstable, failed, aborted, and not-built statuses as well as Job DSL script to create a folder with projects that have these five different statuses.

docs/examples/jenkins/build-status-pipelines/README.md

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to run Jenkins inside a container with Docker client that controls host machines Docker engine using a socket.
+---
+
 # Jenkins with access to hosts Docker engine
 
 Note that by default each of the example docker compose configurations will create their own volumes for the data. This might not be what you want. In order to use the same volumes for every docker compose configuration, run docker compose with `-p` (or `--project-name`) option. This can also be done by setting `COMPOSE_PROJECT_NAME` environment variable:

docs/examples/jenkins/jenkins-host-docker/README.md

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to configure a Jenkins pipeline that executes Robot Framework automation tasks with docker agent in parallel stages as well as combines and stores the produced HTML/XML report files.
+---
+
 # Parallel Robot Framework pipeline
 
 This directory provides an example of a Jenkins pipeline that executes Robot Framework automation tasks with docker agent in parallel stages as well as combines and stores the produced HTML/XML report files.

docs/examples/jenkins/parallel-robot-pipeline/README.md

@@ -1,3 +1,7 @@
+---
+description: Tutorial on how to push code scanning results from Jenkins pipeline to SonarQube and how to display SonarQube data in Jenkins.
+---
+
 # Jenkins and SonarQube
 
 This example uses the same Jenkins configuration as the [Jenkins with access to hosts Docker engine](../jenkins-host-docker/) example. If you did any configuration in [jenkins-host-docker](../jenkins-host-docker/) directory, sync the project names with `-p`/`--project-name` option or `COMPOSE_PROJECT_NAME` environment variable to use the same volumes. For example:

docs/examples/jenkins/sonarqube-jenkins/README.md

@@ -12,39 +12,40 @@ docs_dir: docs/
 edit_uri: edit/main/docs/
 
 nav:
-- Home: README.md
-- Docker:
-  - ./examples/docker/docker-on-wsl/README.md
-- Jenkins:
-  - ./examples/jenkins/jenkins-host-docker/README.md
-  - ./examples/jenkins/ansible-kubernetes/README.md
-  - ./examples/jenkins/build-status-pipelines/README.md
-  - ./examples/jenkins/parallel-robot-pipeline/README.md
-  - ./examples/jenkins/sonarqube-jenkins/README.md
+  - Home: README.md
+  - Docker:
+      - ./examples/docker/docker-on-wsl/README.md
+  - Jenkins:
+      - ./examples/jenkins/jenkins-host-docker/README.md
+      - ./examples/jenkins/ansible-kubernetes/README.md
+      - ./examples/jenkins/build-status-pipelines/README.md
+      - ./examples/jenkins/parallel-robot-pipeline/README.md
+      - ./examples/jenkins/sonarqube-jenkins/README.md
 not_in_nav: |
   assets/README.md
 
 theme:
   name: material
   custom_dir: overrides
+  logo: assets/logo.svg
   favicon: assets/favicon.png
   palette:
-  - media: "(prefers-color-scheme: light)"
-    scheme: default
-    primary: blue grey
-    accent: deep orange
-    toggle:
-      icon: material/weather-sunny
-      name: Switch to dark mode
-  - media: "(prefers-color-scheme: dark)"
-    scheme: slate
-    primary: blue grey
-    accent: deep orange
-    toggle:
-      icon: material/weather-night
-      name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: blue grey
+      accent: deep orange
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue grey
+      accent: deep orange
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
   font:
-    text: Source Sans Pro
+    text: Source Sans 3
     code: Source Code Pro
   language: en
   features:
@@ -54,12 +55,13 @@ theme:
     - navigation.sections
 
 plugins:
-  - search
   - git-committers:
       repository: kangasta/cicd-examples
       branch: main
   - git-revision-date-localized:
       enable_creation_date: true
+  - search
+  - social
 
 markdown_extensions:
   - admonition

mkdocs.yaml

@@ -1,5 +1,5 @@
 # Dependencies for auto-generating and developing docs
 mkdocs~=1.5
-mkdocs-material~=9.5
+mkdocs-material[imaging]~=9.5
 mkdocs-git-revision-date-localized-plugin~=1.2
 mkdocs-git-committers-plugin-2~=2.4