feat: create initial mkdocs configs for GitHub Pages

Added GitHub Pages via mkdocs

.github/workflows/mkdocs.yaml

@@ -0,0 +1,59 @@
+name: pages build and deployment
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/mkdocs.yml"
+  pull_request:
+    paths:
+      - "docs/**"
+      - ".github/workflows/mkdocs.yml"
+  workflow_dispatch:
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install -r requirements-docs.txt
+      - run: mkdocs build
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: site/
+
+  deploy:
+    # depend on the docs being built
+    needs: build
+
+    # ensure we only run on commits to the main branch
+    if: github.ref == 'refs/heads/main'
+
+    runs-on: ubuntu-latest
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: "github-pages"
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

docs/index.md

@@ -0,0 +1 @@
+# UnderStack

mkdocs.yml

@@ -0,0 +1,50 @@
+---
+site_name: UnderStack
+site_description: |-
+  OpenStack based bare-metal deployment environment with DCIM and IPAM support
+
+theme:
+  name: material
+
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  features:
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - navigation.instant
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - toc.follow
+
+repo_name: rackerlabs/understack
+repo_url: https://github.com/rackerlabs/understack
+dev_addr: "127.0.0.1:8001"
+edit_uri: "edit/main/docs"
+
+copyright: Copyright © 2024 Rackspace Technology, Inc.
+
+markdown_extensions:
+  - admonition
+  - attr_list
+  - def_list
+
+plugins:
+  - search
+
+nav:
+  - index.md

requirements-docs.txt

@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material