add deployment for dev and master (#59)

change structure of documentation in order to follow diataxis change mail contact Co-authored-by: St0n14 <alexis.debrito@lgm.fr>
PyDFIR · Aug 21, 2024 · aedb3aa · aedb3aa
1 parent 6c0ff92
commit aedb3aa
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 18 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -4,6 +4,7 @@ on:
     branches:
       - main
       - dev
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -12,5 +13,17 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
-      - run: mkdocs gh-deploy --force --clean --verbose
+
+      # Install required dependencies
+      - run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mike
+
+      # Deploy the documentation
+      - name: Deploy documentation
+        run: |
+          BRANCH=$(echo "${GITHUB_REF#refs/heads/}")
+          if [ "$BRANCH" = "main" ]; then
+            mike deploy --update-aliases latest
+          elif [ "$BRANCH" = "dev" ]; then
+            mike deploy dev
+          fi
+          mike deploy --push --clean
diff --git a/docs/reference/test.md → docs/Guide/test.md b/docs/reference/test.md → docs/Guide/test.md
diff --git a/docs/Usage/installation.md → docs/Tutorials/installation.md b/docs/Usage/installation.md → docs/Tutorials/installation.md
diff --git a/docs/Usage/linux.md → docs/Tutorials/linux.md b/docs/Usage/linux.md → docs/Tutorials/linux.md
diff --git a/docs/Usage/usage.md → docs/Tutorials/usage.md b/docs/Usage/usage.md → docs/Tutorials/usage.md
diff --git a/docs/Usage/windows.md → docs/Tutorials/windows.md b/docs/Usage/windows.md → docs/Tutorials/windows.md
diff --git a/docs/explanation.md → docs/explanation/explanation.md b/docs/explanation.md → docs/explanation/explanation.md
diff --git a/docs/index.md b/docs/index.md
@@ -8,10 +8,10 @@ project documentation as described by Daniele Procida
 in the [Diátaxis documentation framework](https://diataxis.fr/)
 and consists of four separate parts:
 
-1. [Tutorials](./Usage/installation.md)
+1. [Tutorials](./Tutorials/installation.md)
 2. [How-To Guides](./Usage/usage.md)
-3. [Reference](reference/reference.md)
-4. [Explanation](explanation.md)
+3. [Reference](./reference/reference.md)
+4. [Explanation](./explanation.md)
 
 Quickly find what you're looking for depending on
 your use case by looking at the different pages.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -54,19 +54,23 @@ markdown_extensions:
 
 nav:
   - index.md
-  - explanation.md
-  - Usage:
-    - Installation : Usage/installation.md
-    - Windows : Usage/windows.md
-    - Linux/Mac : Usage/linux.md
+  - Tutorials:
+    - Installation : Tutorials/installation.md
+    - Windows : Tutorials/windows.md
+    - Linux/Mac : Tutorials/linux.md
   - Reference:
-      - Index: reference/reference.md
-      - Base: reference/base.md
-      - Handler: reference/handler.md
-      - Renderer: reference/renderer.md
-      - Utils: reference/utils.md
-      - Windows : reference/windows.md
-      - Testing : reference/test.md
+    - Index: reference/reference.md
+    - Base: reference/base.md
+    - Handler: reference/handler.md
+    - Renderer: reference/renderer.md
+    - Utils: reference/utils.md
+    - Windows : reference/windows.md
+    - Testing : reference/test.md
+  - Explanation:
+    - Explanation : explanation/explanation.md
+  - Guide:
+    - Testing : Guide/test.md
+
 
 extra:
   version:
@@ -76,4 +80,4 @@ extra:
       link: https://github.com/PyDFIR/pyDFIRRam
       name: Github
     - icon: material/email
-      link: "mailto:alexis.debrito@ecole2600.com"
+      link: "mailto:alexis.debrito@pm.me"