Add action to test docs build and automate tutorials (#44)

Author: moritzmeister

.github/workflows/mkdocs-release.yml

@@ -0,0 +1,40 @@
+name: mkdocs-release
+
+on:
+  push:
+    branches: [ branch-* ]
+
+jobs:
+  publish-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Checkout hopsworks-tutorials
+        uses: actions/checkout@v3
+        with:
+          repository: logicalclocks/hopsworks-tutorials
+          path: docs/hopsworks-tutorials
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: install deps
+        run: pip3 install pip==22.0.3 && pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python'
+
+      - name: copy tutorial images
+        run: python prepare_images.py
+
+      - name: setup git
+        run: |
+          git config --global user.name Mike
+          git config --global user.email mike@docs.hopsworks.ai
+
+      # Put this back and increment version when cutting a new release branch
+      # - name: mike deploy docs
+      #  run: mike deploy 3.0 latest -u --push

.github/workflows/mkdocs-test.yml

@@ -0,0 +1,38 @@
+name: mkdocs-test
+
+on: pull_request
+
+jobs:
+  test-docs-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Checkout hopsworks-tutorials
+        uses: actions/checkout@v3
+        with:
+          repository: logicalclocks/hopsworks-tutorials
+          path: docs/hopsworks-tutorials
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      - name: install deps
+        run: pip3 install pip==22.0.3 && pip3 install 'git+https://github.com/logicalclocks/feature-store-api@master#egg=hsfs[docs]&subdirectory=python'
+
+      - name: copy tutorial images
+        run: python prepare_images.py
+
+      - name: setup git
+        run: |
+          git config --global user.name Mike
+          git config --global user.email mike@docs.hopsworks.ai
+
+      - name: mike deploy docs
+        run: mike deploy 3.1-SNAPSHOT dev -u

.gitignore

@@ -109,6 +109,7 @@ venv.bak/
 
 # mkdocs documentation
 site/
+docs/hopsworks-tutorials/
 
 # mypy
 .mypy_cache/

docs/getting_started/images/01_featuregroups.png

@@ -10,16 +10,16 @@ edit_uri: ""
 
 nav:
   - Home: index.md
-  - Getting Started: getting_started/quickstart.ipynb
+  - Getting Started: hopsworks-tutorials/quickstart.ipynb
   - Tutorials:
     - Fraud Batch:
-      - 1. Feature Groups: tutorials/fraud_batch/1_feature_groups.ipynb
-      - 2. Feature View: tutorials/fraud_batch/2_feature_view_creation.ipynb
-      - 3. Model Training: tutorials/fraud_batch/3_model_training.ipynb
+      - 1. Feature Groups: hopsworks-tutorials/fraud_batch/1_feature_groups.ipynb
+      - 2. Feature View: hopsworks-tutorials/fraud_batch/2_feature_view_creation.ipynb
+      - 3. Model Training: hopsworks-tutorials/fraud_batch/3_model_training.ipynb
     - Fraud Online:
-      - 1. Feature Groups: tutorials/fraud_online/1_feature_groups.ipynb
-      - 2. Feature View: tutorials/fraud_online/2_feature_view_creation.ipynb
-      - 3. Model Training: tutorials/fraud_online/3_model_training.ipynb
+      - 1. Feature Groups: hopsworks-tutorials/fraud_online/1_feature_groups.ipynb
+      - 2. Feature View: hopsworks-tutorials/fraud_online/2_feature_view_creation.ipynb
+      - 3. Model Training: hopsworks-tutorials/fraud_online/3_model_training.ipynb
   - Concepts:
     - Hopsworks Platform: concepts/hopsworks.md
     - Feature Store:

docs/getting_started/images/02_training-dataset.png

@@ -0,0 +1,20 @@
+import argparse
+import shutil
+import os
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--path', '-p', help="path to the hopsworks tutorials dir", type=str, default="docs/hopsworks-tutorials")
+    parser.add_argument('--src', '-s', help="name of directory with images to copy", type=str, default="images")
+
+    args = parser.parse_args()
+
+    except_dirs = [".git", args.src]
+
+    sub_dirs = [
+        element for element in os.listdir(args.path)
+        if os.path.isdir(os.path.join(args.path, element)) and element not in except_dirs
+    ]
+
+    for dst in sub_dirs:
+        shutil.copytree(os.path.join(args.path, args.src), os.path.join(args.path, dst, args.src), dirs_exist_ok=True)