docs: add docs

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Release Docs
+
+on:
+  push:
+    tags:
+      - "v*"
+    branches:
+      - main
+
+jobs:
+  release_docs:
+    name: Release Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+          cache: "pip"
+          cache-dependency-path: "./docs/scripts/requirements.txt"
+      - run: |
+          pip install -r docs/scripts/requirements.txt
+      - name: setup
+        run: |
+          ./docs/scripts/copy-docs.sh
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: build and push
+        run: |
+          mike deploy ${{ github.ref_name }} latest --push --update-aliases
+          mike set-default --push latest

docs/getting-started/install.md

@@ -0,0 +1,3 @@
+# Install
+
+TODO

docs/getting-started/uninstall.md

@@ -0,0 +1,3 @@
+# Uninstall
+
+TODO

docs/getting-started/upgrade.md

@@ -0,0 +1,3 @@
+# Upgrade
+
+TODO

docs/index.md

@@ -0,0 +1,22 @@
+---
+title: Home
+hide:
+  - navigation
+  - toc
+---
+
+# Pterodactyl on Kubernetes
+
+This project brings the awesome Pterodactyl Panel to Kubernetes.
+
+## Helm chart
+
+Helm chart is currently not available in the GitHub repository, it is in really early stage. For more, see [Roadmap](roadmap.md).
+
+## Docker image
+
+Docker images are currently built nightly and on push, the CI will be tweaked later, see [Roadmap](roadmap.md)
+
+## LICENSE
+
+This project is licensed with MIT License, see [LICENSE](https://github.com/acaslab/pterodactyl-on-k8s/blob/main/LICENSE) in the repository.

docs/internals/docker-build.md

@@ -0,0 +1,13 @@
+# Docker build
+
+There are currently two channels setup.
+
+Nightly and release.
+
+## Nightly
+
+Nightly as the name suggest is build every night on schedule with latest version of Pterodactyl Panel.
+
+## Release
+
+Release on the other hand is build with tagged versions of Pterodactyl Panel and is considered to be used in production.

docs/internals/releases.md

@@ -0,0 +1,15 @@
+# Releases
+
+Currently releases are hand made, but it is planned to automate the release process via GitHub Actions.
+
+For more information, see [Roadmap](../roadmap.md)
+
+## Versioning
+
+As said in the [Changelog](../changelog.md), this project is currently under active development and releases are following [zer0ver](https://0ver.org/) until a stable release.
+
+When times come for a stable release, [Semantic Versioning](https://semver.org/spec/v2.0.0.html) will be strictly followed.
+
+## Stable release
+
+There is currently no ETA.

docs/roadmap.md

@@ -0,0 +1,21 @@
+---
+hide:
+  - navigation
+---
+
+# Roadmap
+
+
+## Phase one: Proof of Concept
+
+- [X] Docker image build
+- [ ] Basic Helm chart
+
+## Phase two: Automation
+
+- [ ] Automate releases with GitHub Actions
+- [ ] Kubernetes autoscaling via [HPA](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
+
+## Phase three: Stable release
+
+- [ ] Create first stable release (e.g. `1.0.0`)

docs/scripts/copy-docs.sh

@@ -0,0 +1,3 @@
+set -eo pipefail
+
+cp CHANGELOG.md changelog.md ./docs/

docs/scripts/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs == 1.3.1
+mkdocs-material == 8.4.3
+mike == 1.1.2

mkdocs.yml

@@ -0,0 +1,38 @@
+site_name: Pterodactyl on Kubernetes Docs
+site_url: https://docs.acaslab.com/pterodactyl-on-k8s
+
+repo_url: https://github.com/acaslab/pterodactyl-on-k8s/
+repo_name: acaslab/pterodactyl-on-k8s
+
+edit_uri: edit/main/docs/
+
+nav:
+  - Home: index.md
+  - Getting Started:
+    - Install: getting-started/install.md
+    - Upgrade: getting-started/upgrade.md
+    - Uninstall: getting-started/uninstall.md
+  - Roadmap: roadmap.md
+  - Internals:
+    - Releases: internals/releases.md
+    - Docker build: internals/docker-build.md
+  - Changelog: changelog.md
+
+theme:
+  name: material
+  locale: en
+  highlightjs: true
+  features:
+    - navigation.tabs
+    - navigation.tracking
+    - navigation.sections
+    - toc.follow
+
+extra:
+  version:
+    provider: mike
+    default: latest
+
+markdown_extensions:
+  - pymdownx.tasklist:
+      custom_checkbox: true