[CREATE] airflow-mnist-example and Kubernetes Documentations

leoho0722 · Apr 12, 2024 · 29aefb1 · 29aefb1
1 parent dcd276b
commit 29aefb1
Show file tree

Hide file tree

Showing 37 changed files with 767 additions and 1 deletion.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -0,0 +1,78 @@
+name: Build documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: 'Writerside/hi'
+  ARTIFACT: 'webHelpHI2-all.zip'
+  DOCKER_VERSION: '233.14938'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build docs using Writerside Docker builder
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Save artifact with build results
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+  test:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [build, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Package and upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+# IDE
+.idea
+.vscode
diff --git a/README.md b/README.md
@@ -1 +1,8 @@
-# docs
+# docs-repo
+
+All publicly available documentations in my GitHub Repository.
+
+## Environment
+
+* macOS Sonoma 14.4.1
+* JetBrains Writerside
diff --git a/docs/Writerside/c.list b/docs/Writerside/c.list
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>
diff --git a/docs/Writerside/hi.tree b/docs/Writerside/hi.tree
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="hi"
+                 name="Documentation"
+                 start-page="Home.md">
+
+    <toc-element topic="Home.md">
+        <toc-element topic="airflow-mnist-example.md">
+            <toc-element topic="airflow-mnist-example-Install-on-Ubuntu.md"/>
+        </toc-element>
+        <toc-element topic="kubernetes.md">
+            <toc-element topic="Using-NVIDIA-GPU-Resources-on-Kubernetes.md"/>
+        </toc-element>
+    </toc-element>
+</instance-profile>
diff --git a/docs/Writerside/images/completion_procedure.png b/docs/Writerside/images/completion_procedure.png
diff --git a/docs/Writerside/images/completion_procedure_dark.png b/docs/Writerside/images/completion_procedure_dark.png
diff --git a/docs/Writerside/images/convert_table_to_xml.png b/docs/Writerside/images/convert_table_to_xml.png
diff --git a/docs/Writerside/images/convert_table_to_xml_dark.png b/docs/Writerside/images/convert_table_to_xml_dark.png
diff --git a/docs/Writerside/images/new_topic_options.png b/docs/Writerside/images/new_topic_options.png
diff --git a/docs/Writerside/images/new_topic_options_dark.png b/docs/Writerside/images/new_topic_options_dark.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_15.59.08.png b/docs/Writerside/images/截圖_2024-04-12_15.59.08.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_15.59.51.png b/docs/Writerside/images/截圖_2024-04-12_15.59.51.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_16.02.24.png b/docs/Writerside/images/截圖_2024-04-12_16.02.24.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_16.12.08.png b/docs/Writerside/images/截圖_2024-04-12_16.12.08.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_16.13.46.png b/docs/Writerside/images/截圖_2024-04-12_16.13.46.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_16.49.14.png b/docs/Writerside/images/截圖_2024-04-12_16.49.14.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_16.54.35.png b/docs/Writerside/images/截圖_2024-04-12_16.54.35.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.00.37.png b/docs/Writerside/images/截圖_2024-04-12_17.00.37.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.01.39.png b/docs/Writerside/images/截圖_2024-04-12_17.01.39.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.13.18.png b/docs/Writerside/images/截圖_2024-04-12_17.13.18.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.19.22.png b/docs/Writerside/images/截圖_2024-04-12_17.19.22.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.21.06.png b/docs/Writerside/images/截圖_2024-04-12_17.21.06.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.24.56.png b/docs/Writerside/images/截圖_2024-04-12_17.24.56.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.25.41.png b/docs/Writerside/images/截圖_2024-04-12_17.25.41.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.30.50.png b/docs/Writerside/images/截圖_2024-04-12_17.30.50.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.32.46.png b/docs/Writerside/images/截圖_2024-04-12_17.32.46.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_17.47.34.png b/docs/Writerside/images/截圖_2024-04-12_17.47.34.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_18.30.15.png b/docs/Writerside/images/截圖_2024-04-12_18.30.15.png
diff --git a/docs/Writerside/images/截圖_2024-04-12_18.46.28.png b/docs/Writerside/images/截圖_2024-04-12_18.46.28.png
diff --git a/docs/Writerside/topics/Home.md b/docs/Writerside/topics/Home.md
@@ -0,0 +1,7 @@
+# Docs Repository
+
+## Contents
+
+* [airflow-mnist-example](airflow-mnist-example.md)
+  * [GitHub Repository](https://github.com/leoho0722/airflow-mnist-example)
+* [Kubernetes](kubernetes.md)
diff --git a/docs/Writerside/topics/airflow-mnist-example.md b/docs/Writerside/topics/airflow-mnist-example.md
@@ -0,0 +1,13 @@
+# airflow-mnist-example
+
+## Contents
+
+* [Install on Ubuntu](airflow-mnist-example-Install-on-Ubuntu.md)
+* [Download MNIST Datasets](#download-mnist-datasets)
+
+### Download MNIST Datasets
+
+```Shell
+cd ~
+wget https://storage.googleapis.com/tensorflow/tf-keras-datasets/mnist.npz
+```
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    # IDE
+    .idea
+    .vscode