From 7d8ff5fd1e7d6b72d0ac1cc0935163269faeb601 Mon Sep 17 00:00:00 2001 From: Vojtech Mares Date: Sat, 10 Sep 2022 16:18:58 +0200 Subject: [PATCH] docs: add docs --- .github/workflows/docs.yml | 35 ++++++++++++++++++++++++++++ docs/getting-started/install.md | 3 +++ docs/getting-started/uninstall.md | 3 +++ docs/getting-started/upgrade.md | 3 +++ docs/index.md | 22 ++++++++++++++++++ docs/internals/docker-build.md | 13 +++++++++++ docs/internals/releases.md | 15 ++++++++++++ docs/roadmap.md | 21 +++++++++++++++++ docs/scripts/copy-docs.sh | 3 +++ docs/scripts/requirements.txt | 3 +++ mkdocs.yml | 38 +++++++++++++++++++++++++++++++ 11 files changed, 159 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/getting-started/install.md create mode 100644 docs/getting-started/uninstall.md create mode 100644 docs/getting-started/upgrade.md create mode 100644 docs/index.md create mode 100644 docs/internals/docker-build.md create mode 100644 docs/internals/releases.md create mode 100644 docs/roadmap.md create mode 100644 docs/scripts/copy-docs.sh create mode 100644 docs/scripts/requirements.txt create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..913ab40 --- /dev/null +++ b/.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 diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md new file mode 100644 index 0000000..3594e09 --- /dev/null +++ b/docs/getting-started/install.md @@ -0,0 +1,3 @@ +# Install + +TODO diff --git a/docs/getting-started/uninstall.md b/docs/getting-started/uninstall.md new file mode 100644 index 0000000..d1509e9 --- /dev/null +++ b/docs/getting-started/uninstall.md @@ -0,0 +1,3 @@ +# Uninstall + +TODO diff --git a/docs/getting-started/upgrade.md b/docs/getting-started/upgrade.md new file mode 100644 index 0000000..b5a131f --- /dev/null +++ b/docs/getting-started/upgrade.md @@ -0,0 +1,3 @@ +# Upgrade + +TODO diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b6cd9e1 --- /dev/null +++ b/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. diff --git a/docs/internals/docker-build.md b/docs/internals/docker-build.md new file mode 100644 index 0000000..baceb3f --- /dev/null +++ b/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. diff --git a/docs/internals/releases.md b/docs/internals/releases.md new file mode 100644 index 0000000..99f7184 --- /dev/null +++ b/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. diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 0000000..1b1876a --- /dev/null +++ b/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`) diff --git a/docs/scripts/copy-docs.sh b/docs/scripts/copy-docs.sh new file mode 100644 index 0000000..02b191b --- /dev/null +++ b/docs/scripts/copy-docs.sh @@ -0,0 +1,3 @@ +set -eo pipefail + +cp CHANGELOG.md changelog.md ./docs/ diff --git a/docs/scripts/requirements.txt b/docs/scripts/requirements.txt new file mode 100644 index 0000000..c89a7f0 --- /dev/null +++ b/docs/scripts/requirements.txt @@ -0,0 +1,3 @@ +mkdocs == 1.3.1 +mkdocs-material == 8.4.3 +mike == 1.1.2 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..15782ca --- /dev/null +++ b/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