1
0
Fork 0

docs: add docs

This commit is contained in:
Vojtěch Mareš 2022-09-10 16:18:58 +02:00
parent c786404692
commit 7d8ff5fd1e
Signed by: vojtech.mares
GPG key ID: C6827B976F17240D
11 changed files with 159 additions and 0 deletions

View file

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

View file

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

View file

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

22
docs/index.md Normal file
View file

@ -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.

View file

@ -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.

View file

@ -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.

21
docs/roadmap.md Normal file
View file

@ -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`)

View file

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

View file

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