Merge pull request #182 from IBM/mkdocs

add support for gh pages and mkdocs
IBM · Jan 15, 2021 · 5ec7881 · 5ec7881
2 parents df32189 + aed79fc
commit 5ec7881
Show file tree

Hide file tree

Showing 47 changed files with 117 additions and 3 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -1,6 +1,6 @@
 # Do not edit this file, to adjust the table of contents, modify SUMMARY.md
 
-root: ./workshop/
+root: ./docs/
 
 structure:
   readme: README.md

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,16 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/.travis.yml b/.travis.yml
@@ -5,5 +5,5 @@ node_js: 10
 before_script:
   - npm install markdownlint-cli
 script:
-  - markdownlint -c .markdownlint.json workshop --ignore workshop/SUMMARY.md
-  - ./.verify-links.sh -v workshop
+  - markdownlint -c .markdownlint.json docs --ignore docs/SUMMARY.md
+  - ./.verify-links.sh -v docs
diff --git a/workshop/README.md → docs/README.md b/workshop/README.md → docs/README.md
diff --git a/workshop/README_images/firefoxchrome.png → docs/README_images/firefoxchrome.png b/workshop/README_images/firefoxchrome.png → docs/README_images/firefoxchrome.png
diff --git a/workshop/README_images/grafana.png → docs/README_images/grafana.png b/workshop/README_images/grafana.png → docs/README_images/grafana.png
diff --git a/workshop/README_images/guestbook1.png → docs/README_images/guestbook1.png b/workshop/README_images/guestbook1.png → docs/README_images/guestbook1.png
diff --git a/workshop/README_images/guestbook2.png → docs/README_images/guestbook2.png b/workshop/README_images/guestbook2.png → docs/README_images/guestbook2.png
diff --git a/workshop/README_images/istio1.jpg → docs/README_images/istio1.jpg b/workshop/README_images/istio1.jpg → docs/README_images/istio1.jpg
diff --git a/workshop/README_images/istio2.jpg → docs/README_images/istio2.jpg b/workshop/README_images/istio2.jpg → docs/README_images/istio2.jpg
diff --git a/workshop/README_images/istio3.jpg → docs/README_images/istio3.jpg b/workshop/README_images/istio3.jpg → docs/README_images/istio3.jpg
diff --git a/workshop/README_images/jaeger.png → docs/README_images/jaeger.png b/workshop/README_images/jaeger.png → docs/README_images/jaeger.png
diff --git a/workshop/README_images/kiali.png → docs/README_images/kiali.png b/workshop/README_images/kiali.png → docs/README_images/kiali.png
diff --git a/workshop/README_images/mtlsTraffic.png → docs/README_images/mtlsTraffic.png b/workshop/README_images/mtlsTraffic.png → docs/README_images/mtlsTraffic.png
diff --git a/...E_images/observability-logging-logdna.png → ...E_images/observability-logging-logdna.png b/...E_images/observability-logging-logdna.png → ...E_images/observability-logging-logdna.png
diff --git a/...mages/observability-monitoring-sysdig.png → ...mages/observability-monitoring-sysdig.png b/...mages/observability-monitoring-sysdig.png → ...mages/observability-monitoring-sysdig.png
diff --git a/workshop/README_images/prometheus.jpg → docs/README_images/prometheus.jpg b/workshop/README_images/prometheus.jpg → docs/README_images/prometheus.jpg
diff --git a/workshop/README_images/prometheus.png → docs/README_images/prometheus.png b/workshop/README_images/prometheus.png → docs/README_images/prometheus.png
diff --git a/workshop/README_images/sysdig2.png → docs/README_images/sysdig2.png b/workshop/README_images/sysdig2.png → docs/README_images/sysdig2.png
diff --git a/workshop/SUMMARY.md → docs/SUMMARY.md b/workshop/SUMMARY.md → docs/SUMMARY.md
diff --git a/workshop/cleanup/clean_your_k8s_cluster.sh → docs/cleanup/clean_your_k8s_cluster.sh b/workshop/cleanup/clean_your_k8s_cluster.sh → docs/cleanup/clean_your_k8s_cluster.sh
diff --git a/workshop/cleanup/clean_your_local_machine.sh → docs/cleanup/clean_your_local_machine.sh b/workshop/cleanup/clean_your_local_machine.sh → docs/cleanup/clean_your_local_machine.sh
diff --git a/workshop/exercise-1/README.md → docs/exercise-1/README.md b/workshop/exercise-1/README.md → docs/exercise-1/README.md
diff --git a/workshop/exercise-2/README.md → docs/exercise-2/README.md b/workshop/exercise-2/README.md → docs/exercise-2/README.md
diff --git a/workshop/exercise-3/README.md → docs/exercise-3/README.md b/workshop/exercise-3/README.md → docs/exercise-3/README.md
diff --git a/workshop/exercise-4/README.md → docs/exercise-4/README.md b/workshop/exercise-4/README.md → docs/exercise-4/README.md
diff --git a/workshop/exercise-5/README.md → docs/exercise-5/README.md b/workshop/exercise-5/README.md → docs/exercise-5/README.md
diff --git a/workshop/exercise-6/README.md → docs/exercise-6/README.md b/workshop/exercise-6/README.md → docs/exercise-6/README.md
diff --git a/workshop/exercise-7/README.md → docs/exercise-7/README.md b/workshop/exercise-7/README.md → docs/exercise-7/README.md
diff --git a/workshop/exercise-7/waiting_on_database.png → docs/exercise-7/waiting_on_database.png b/workshop/exercise-7/waiting_on_database.png → docs/exercise-7/waiting_on_database.png
diff --git a/workshop/final-quizes → docs/final-quizes b/workshop/final-quizes → docs/final-quizes
diff --git a/workshop/plans/analyzer-egress.yaml → docs/plans/analyzer-egress.yaml b/workshop/plans/analyzer-egress.yaml → docs/plans/analyzer-egress.yaml
diff --git a/workshop/plans/frontdoor-ingress.yaml → docs/plans/frontdoor-ingress.yaml b/workshop/plans/frontdoor-ingress.yaml → docs/plans/frontdoor-ingress.yaml
diff --git a/workshop/plans/guestbook-destination.yaml → docs/plans/guestbook-destination.yaml b/workshop/plans/guestbook-destination.yaml → docs/plans/guestbook-destination.yaml
diff --git a/workshop/plans/guestbook-frontdoor.yaml → docs/plans/guestbook-frontdoor.yaml b/workshop/plans/guestbook-frontdoor.yaml → docs/plans/guestbook-frontdoor.yaml
diff --git a/workshop/plans/guestbook-gateway.yaml → docs/plans/guestbook-gateway.yaml b/workshop/plans/guestbook-gateway.yaml → docs/plans/guestbook-gateway.yaml
diff --git a/workshop/plans/guestbook-ingress.yaml → docs/plans/guestbook-ingress.yaml b/workshop/plans/guestbook-ingress.yaml → docs/plans/guestbook-ingress.yaml
diff --git a/workshop/plans/guestbook-telemetry.yaml → docs/plans/guestbook-telemetry.yaml b/workshop/plans/guestbook-telemetry.yaml → docs/plans/guestbook-telemetry.yaml
diff --git a/workshop/plans/mixer-rule-denial.yaml → docs/plans/mixer-rule-denial.yaml b/workshop/plans/mixer-rule-denial.yaml → docs/plans/mixer-rule-denial.yaml
diff --git a/workshop/plans/routerule-all-v1.yaml → docs/plans/routerule-all-v1.yaml b/workshop/plans/routerule-all-v1.yaml → docs/plans/routerule-all-v1.yaml
diff --git a/workshop/plans/routerule-all-v2.yaml → docs/plans/routerule-all-v2.yaml b/workshop/plans/routerule-all-v2.yaml → docs/plans/routerule-all-v2.yaml
diff --git a/workshop/plans/serviceentry-tone.yaml → docs/plans/serviceentry-tone.yaml b/workshop/plans/serviceentry-tone.yaml → docs/plans/serviceentry-tone.yaml
diff --git a/workshop/plans/virtualservice-80-20.yaml → docs/plans/virtualservice-80-20.yaml b/workshop/plans/virtualservice-80-20.yaml → docs/plans/virtualservice-80-20.yaml
diff --git a/workshop/plans/virtualservice-all-v1.yaml → docs/plans/virtualservice-all-v1.yaml b/workshop/plans/virtualservice-all-v1.yaml → docs/plans/virtualservice-all-v1.yaml
diff --git a/workshop/plans/virtualservice-test.yaml → docs/plans/virtualservice-test.yaml b/workshop/plans/virtualservice-test.yaml → docs/plans/virtualservice-test.yaml
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,98 @@
+# Project information
+site_name: Istio 101 Workshop
+site_url: https://ibm.github.io/istio101
+site_author: IBM Developer
+
+# Repository
+repo_name: istio101
+repo_url: https://github.com/ibm/istio101
+edit_uri: edit/master/docs
+
+# Navigation
+nav:
+  - Welcome:
+    - About the workshop: README.md
+  - Workshop:
+    - Lab 1. Access a Kubernetes cluster: exercise-1/README.md
+    - Lab 2. Install Istio: exercise-2/README.md
+    - Lab 3. Deploy sample application: exercise-3/README.md
+    - Lab 4. Observe service telemetry metrics: exercise-4/README.md
+    - Lab 5. Expose the service mesh: exercise-5/README.md
+    - Lab 6. Perform traffic management: exercise-6/README.md
+    - Lab 7. Secure your service mesh : exercise-7/README.md
+
+## DO NOT CHANGE BELOW THIS LINE
+
+# Copyright
+copyright: Copyright &copy; 2020 IBM Developer
+
+# Theme
+theme:
+  name: material
+  font:
+    text: IBM Plex Sans
+    code: IBM Plex Mono
+  icon:
+    logo: material/library
+  features:
+    # - navigation.tabs
+    - navigation.instant
+  palette:
+    scheme: default
+    primary: blue
+    accent: blue
+
+# Plugins
+plugins:
+  - search
+
+# Customization
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/ibm
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/ibmdeveloper
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/ibm/
+    - icon: fontawesome/brands/youtube
+      link: https://www.youtube.com/user/developerworks
+    - icon: fontawesome/brands/dev
+      link: https://dev.to/ibmdeveloper
+
+# Extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
diff --git a/workshop/README_images/.DS_Store b/workshop/README_images/.DS_Store