From 3c475615f3b7396c077419e71c47b486cf37a2f1 Mon Sep 17 00:00:00 2001 From: robinbraemer Date: Tue, 16 Apr 2024 16:09:02 +0200 Subject: [PATCH] docs(games): Improvements --- .web/docs/.vitepress/config.ts | 37 ++++++++++--- .web/docs/browser/launch/index.md | 55 +++++++++---------- .web/docs/games/hosting/container.md | 17 ++++++ .web/docs/games/hosting/index.md | 36 ++++++++++++ .web/docs/games/hosting/kubernetes/index.md | 44 +++++++++++++++ .web/docs/games/hosting/kubernetes/level-1.md | 0 .web/docs/games/hosting/kubernetes/level-2.md | 0 .web/docs/games/hosting/kubernetes/level-3.md | 0 .web/docs/games/hosting/kubernetes/level-4.md | 0 .web/docs/games/hosting/kubernetes/levels.md | 52 ++++++++++++++++++ .web/docs/games/hosting/provider.md | 17 ++++++ 11 files changed, 220 insertions(+), 38 deletions(-) create mode 100644 .web/docs/games/hosting/container.md create mode 100644 .web/docs/games/hosting/index.md create mode 100644 .web/docs/games/hosting/kubernetes/index.md create mode 100644 .web/docs/games/hosting/kubernetes/level-1.md create mode 100644 .web/docs/games/hosting/kubernetes/level-2.md create mode 100644 .web/docs/games/hosting/kubernetes/level-3.md create mode 100644 .web/docs/games/hosting/kubernetes/level-4.md create mode 100644 .web/docs/games/hosting/kubernetes/levels.md create mode 100644 .web/docs/games/hosting/provider.md diff --git a/.web/docs/.vitepress/config.ts b/.web/docs/.vitepress/config.ts index cd1a879..b48f1eb 100644 --- a/.web/docs/.vitepress/config.ts +++ b/.web/docs/.vitepress/config.ts @@ -1,4 +1,4 @@ -import {defineConfig} from 'vitepress' +import {DefaultTheme, defineConfig} from 'vitepress' import {discordLink, editLink, gitHubLink, projects} from '../shared' import {additionalTitle, commitRef} from "../shared/cloudflare"; @@ -9,6 +9,13 @@ const ogImage = `${ogUrl}/og-image.png` const ogTitle = 'Minekube Connect' const ogDescription = 'The Ingress Tunnel for Minecraft Servers' +const services: DefaultTheme.SidebarItem = { + text: 'Services', items: [ + {text: 'Minekube Browser →', link: '/browser/'}, + {text: 'Minekube Connect →', link: '/guide/'}, + ] +} + export default defineConfig({ title: `Minekube Connect${additionalTitle}`, description: ogDescription, @@ -223,8 +230,7 @@ export default defineConfig({ } ] }, - {text: 'Minekube Games →', link: '/games/'}, - {text: 'Minekube Connect →', link: '/guide/'}, + services, ], '/games/': [ { @@ -234,21 +240,34 @@ export default defineConfig({ {text: 'Vision', link: '/games/vision'}, ] }, + { + text: 'Hosting Options', items: [ + {text: 'Overview', link: '/games/hosting/'}, + {text: 'Managed Providers', link: '/games/hosting/provider'}, + {text: 'Kubernetes', link: '/games/hosting/kubernetes/'}, + {text: 'Docker', link: '/games/hosting/container'}, + ] + }, + { + text: 'Guides', items: [ + {text: 'Publishing Games →', link: '/games/developers/'}, + {text: 'Becoming Provider →', link: '/games/providers/'}, + ] + }, { text: 'Go to your right place', items: [ - {text: 'For Game Developers →', link: '/games/developers/'}, - {text: 'For Hosting Providers →', link: '/games/providers/'}, + {text: 'Game Developers →', link: '/games/developers/'}, + {text: 'Hosting Providers →', link: '/games/providers/'}, { - text: 'For Server Owners →', link: '/games/servers/', items: [ + text: 'Server Owners →', link: '/games/servers/', items: [ {text: 'Creating a Game Server', link: '/games/servers/create'}, ] }, - {text: 'For Players →', link: '/games/players/'}, + {text: 'Players →', link: '/games/players/'}, ] }, - {text: 'Minekube Browser →', link: '/browser/'}, - {text: 'Minekube Connect →', link: '/guide/'}, + services, ], '/games/developers/': [ { diff --git a/.web/docs/browser/launch/index.md b/.web/docs/browser/launch/index.md index f365b7e..63b618e 100644 --- a/.web/docs/browser/launch/index.md +++ b/.web/docs/browser/launch/index.md @@ -1,47 +1,44 @@ -# Launching Overview on Minekube +# Launching on Minekube Browser -Welcome to the central hub of launching on Minekube, where we empower server creators and game developers to showcase their creations to a passionate Minecraft community. This guide provides an overview of the launch process, offering insights into how to make your game or server stand out and captivate players. +Welcome to the definitive guide for launching on the Minekube Browser, the platform that champions innovation and community within the Minecraft universe. This documentation will walk you through the journey of launching your game or server, helping you to capture the attention and imagination of a global audience of Minecraft enthusiasts. -## What Does Launching Mean on Minekube? +## Understanding Launches on Minekube Browser -Launching on Minekube refers to the process of publicizing a game or game server, making it available to players worldwide. This involves not only technical setup but also community engagement and marketing strategies to ensure a successful introduction to the market. +On Minekube Browser, launching is about more than just revealing your game or server to the world—it's about creating a moment. A successful launch combines preparation, community interaction, and strategic marketing to make a lasting impact. -## Launching a Game Server +### The Launch Types: -For those who have crafted a unique server experience for players: +- **Game Launch:** Introduce your polished game to the community, ready for players to download, enjoy, and share. +- **Server Launch:** Publicize your server, inviting players to join and partake in the unique experience you've crafted. -- **Preparation:** Ensure your game server is configured, polished, and ready for public access. -- **Visibility:** Decide on your server’s visibility in the Minekube community, and set it up for discovery. -- **Engagement:** Engage with potential players, gather feedback, and build a community around your server. +## The Launch Lifecycle -Refer to our [Creating a Game Server](./server) documentation to set up your server, and when ready, follow the steps in our [Launching a Server](./server) guide to go public. +Inspired by the proven approach of Product Hunt, the lifecycle of a launch on Minekube Browser is a dynamic process: -## Launching a Game +1. **Preparation:** Set up your launch page with compelling media, a captivating description, and all the details players need. +2. **Community Building:** Engage with the Minekube community. Connect with players and gather support even before your launch goes live. +3. **Launch Timing:** Choose the perfect time for your launch. While any day can be your launch day, consider aiming for periods of high activity to maximize visibility. +4. **Promotion:** Amplify your launch through your networks. Reach out to your followers, email subscribers, and social media to drive attention and traffic. +5. **Active Engagement:** On launch day, be present to interact with the community. Respond to feedback, answer questions, and foster a conversation around your launch. -For game developers looking to publish their games: +For detailed steps and best practices, visit our [Launching a Game](./game) or [Launching a Server](./server) documentation. -- **Development:** Containerize your game and prepare it for deployment on Minekube. -- **Presentation:** Craft compelling descriptions and media to attract players to your game. -- **Community Interaction:** Build hype, collect feedback, and foster a player base for your game. +## Why Launch with Minekube Browser? -To understand the full process, visit our [Launching a Game](./game) documentation for detailed steps and best practices. +- **Dedicated Audience:** Direct access to a community of avid Minecraft players looking for their next favorite game or server. +- **Robust Platform:** Built on a solid foundation, Minekube Browser ensures that your launch is supported by a seamless and scalable infrastructure. +- **Comprehensive Tools:** From analytics to community feedback, leverage a suite of tools designed to support and enhance your launch. -## The Lifecycle of a Launch +## Your Launch Day -A launch on Minekube is not a one-time event but a lifecycle that includes: +When the big day arrives, it's all about momentum. Encourage your existing audience to visit your launch page, upvote, and leave feedback. The more engagement your launch receives, the more it will be noticed by others in the Minekube community. -- **Pre-Launch:** The planning and preparation phase where you set the stage for your launch. -- **Launch Day:** The day your game or server goes live, which should be marked with promotional activities and community engagement. -- **Post-Launch:** The ongoing process of supporting, updating, and growing your game or server based on player feedback and analytics. +## Post-Launch: Sustaining the Hype -## Why Launch with Minekube? +The end of launch day isn't the finish line. Continue to engage with the community, roll out updates, and use analytics to inform your growth strategy. Your launch is just the beginning of your journey on Minekube Browser. -- **Access to a Dedicated Community:** Tap into a built-in audience of Minecraft enthusiasts ready to explore new content. -- **Robust Infrastructure:** Rely on our solid platform designed for seamless game and server experiences. -- **Support and Tools:** Utilize our comprehensive suite of tools and resources to manage and promote your launch effectively. +## Ready, Set, Launch! -Launch on Minekube to turn your Minecraft visions into reality, engage with a global audience, and grow your presence in the Minecraft ecosystem. We're here to support you every step of the way. +Now that you're equipped with the knowledge and tools for a successful launch, it's time to put your plan into action. Prepare to showcase your game or server to the world, and let's make your launch on Minekube Browser a resounding success. ---- - -*Remember, a successful launch is the result of careful planning, quality content, and active community engagement. Whether you're launching a game or a game server, Minekube is the platform where your Minecraft creations take flight.* \ No newline at end of file +Remember, a successful launch blends careful planning, exceptional content, and a vibrant community presence. Whether you're introducing a new game or inviting players to your server, Minekube Browser is where your creations take center stage. diff --git a/.web/docs/games/hosting/container.md b/.web/docs/games/hosting/container.md new file mode 100644 index 0000000..9b93250 --- /dev/null +++ b/.web/docs/games/hosting/container.md @@ -0,0 +1,17 @@ +# Hosting Minekube Games on Docker + +Running Minekube Games within Docker containers is a straightforward way to get your game server up and running. This section guides you through the process of containerizing your Minekube game server for deployment on any system that supports Docker. + +## Why Docker? + +- **Portability**: Docker containers can run consistently across different environments. +- **Isolation**: Each game server operates within its own environment, with dependencies neatly packaged together. +- **Ease of Use**: With Docker, you can easily start, stop, and manage the lifecycle of your game server. + +## Getting Started + +- **Install Docker**: Ensure you have Docker installed on your host machine. +- **Pull the Minekube Games Image**: Fetch the latest game server image from the Minekube registry. +- **Run Your Container**: Start a game server instance with a single Docker command. + +Follow the detailed instructions below to deploy your Minekube Games server in a Docker container. \ No newline at end of file diff --git a/.web/docs/games/hosting/index.md b/.web/docs/games/hosting/index.md new file mode 100644 index 0000000..663dcf5 --- /dev/null +++ b/.web/docs/games/hosting/index.md @@ -0,0 +1,36 @@ +# Hosting Options for Minekube Games + +Minekube Games is designed with versatility in mind to ensure that you can host your game servers in a way that suits your needs and expertise. Whether you prefer to manage your own infrastructure, rely on containerization, or opt for a managed provider, Minekube Games offers the flexibility to accommodate your choice. + +[[TOC]] + +## Compare hosting solutions + +Consider factors like ease of use, existing infrastructure, and developer needs: + +| Feature | Minekube Providers | Kubernetes | Docker | +|--------------------|---------------------------------------|-------------------------------|---------------------------| +| **Setup** | Easiest | Easy | Moderate | +| **Infrastructure** | Managed | Anywhere | Anywhere | +| **User Interface** | Minekube Web UI | Minekube Web UI | No | +| **Updates** | Automatic | Automatic | Manual | +| **Pricing** | Pay-as-you-go / Subscription / Free | Flexible / Free | Flexible / Free | + +**Recommendations:** + +- For players and low-friction users who want simplicity and ease of use, Minekube Provider's managed solution is recommended, as it offers a user-friendly web UI and handles updates automatically. +- If you already have one or more machines available or an existing Kubernetes cluster, Minekube offers various Kubernetes management levels of control and customization. +- If you're a developer or want to quickly set up a game server without the need for Minekube's web UI and automated updates, Docker can be a lightweight option for running Game containers. + +## Self-hosted Anywhere + +For those who like to keep things under their own control, Minekube Games can run on any platform that supports containers or Kubernetes: + +- **Kubernetes (e.g. k3s)** Recommended: If you're looking for orchestration and scaling capabilities, Kubernetes is the way to go. Whether it's a lightweight k3s setup or a full-fledged Kubernetes cluster, Minekube Games thrives in these environments. +- **Container / Docker** No Minekube Web UI: Ideal for straightforward deployment and local development, running Minekube Games within Docker containers is a popular choice for its simplicity and portability. + +## Managed Provider + +- **Minekube Games Providers**: For ease and convenience, choose one of the Minekube Games Providers. You won't need to worry about the underlying infrastructure and can have your game server up and running in no time, with all the benefits of a managed service. + +Discover the benefits and learn how to get started with each hosting option in the following sections. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/index.md b/.web/docs/games/hosting/kubernetes/index.md new file mode 100644 index 0000000..c74509a --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/index.md @@ -0,0 +1,44 @@ +# Hosting Minekube Games on Kubernetes + +Kubernetes is the preferred choice for self-hosting or providing Minekube game servers at scale, offering robust management capabilities through the Minekube web dashboard. This section will provide you with the necessary information to deploy and manage your Minekube game servers on Kubernetes, including how to scale up to becoming a provider yourself. + +It's no coincidence that we have `kube` in our name! + +[[TOC]] + +## Why Kubernetes? + +Kubernetes is not just about running containers; it's about simplifying complex technology to provide: + +- **Scalability**: Effortlessly scale your game servers to meet player demand. +- **High Availability**: Achieve high availability with Kubernetes' self-healing and automated rollout/rollback capabilities. +- **Load Balancing**: Efficiently manage traffic distribution across your servers for optimal performance. + +## Exclusive Management via Minekube Dashboard + +One of the unique advantages of choosing Kubernetes for your game servers is the ability to manage everything through the Minekube web dashboard. This centralized management solution provides: + +- **Intuitive Interface**: Easily deploy, monitor, and scale your game servers from a user-friendly web interface. +- **Full Control**: Manage server configurations, updates, and player access with just a few clicks. +- **Visibility**: Get insights into your server's performance and usage patterns to make informed decisions. + +## Path to Becoming a Provider + +By hosting your game servers on Kubernetes, you're already a step ahead in the journey of becoming a provider. With Minekube, you have the option to: + +- **Rent Out Your Hardware**: Offer your Kubernetes cluster's resources to host game servers for friends or paying customers. +- **Expand Your Services**: Grow from hosting servers for personal use to becoming a full-fledged Minekube Games provider. + +See the [Providers Documentation](../../providers/) for more information on how you can leverage your Kubernetes setup to start offering services to others and potentially monetize your infrastructure. + +## Getting Started with Kubernetes + +To launch your Minekube game servers on Kubernetes: + +1. **Prepare Your Kubernetes Cluster**: Whether you're setting up a new cluster or using an existing one, ensure it's configured for Minekube Games. +2. **Deploy Minekube Games**: Use our custom Helm charts or Kubernetes manifests to deploy your game servers with ease. +3. **Manage with Minekube Dashboard**: Connect your cluster to the Minekube web dashboard for comprehensive management and oversight. + +Detailed instructions for each step are provided below, guiding you through the process of deploying and managing your Minekube Games server with Kubernetes. + +Embrace the power of Kubernetes and the convenience of the Minekube dashboard to create an unparalleled gaming experience for your community. Whether for personal enjoyment or as a stepping stone to becoming a provider, Kubernetes offers the flexibility and control you need to succeed in the Minekube ecosystem. \ No newline at end of file diff --git a/.web/docs/games/hosting/kubernetes/level-1.md b/.web/docs/games/hosting/kubernetes/level-1.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/games/hosting/kubernetes/level-2.md b/.web/docs/games/hosting/kubernetes/level-2.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/games/hosting/kubernetes/level-3.md b/.web/docs/games/hosting/kubernetes/level-3.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/games/hosting/kubernetes/level-4.md b/.web/docs/games/hosting/kubernetes/level-4.md new file mode 100644 index 0000000..e69de29 diff --git a/.web/docs/games/hosting/kubernetes/levels.md b/.web/docs/games/hosting/kubernetes/levels.md new file mode 100644 index 0000000..f1e0028 --- /dev/null +++ b/.web/docs/games/hosting/kubernetes/levels.md @@ -0,0 +1,52 @@ +# Kubernetes Management Levels + +At Minekube, we understand that every user has different needs and preferences when it comes to managing their Kubernetes cluster. That's why we offer four different levels of management, ranging from fully managed to highly customizable. + +No matter which level you choose, you'll always have admin access to your final Kubernetes cluster, and our goal is to provide a managed experience through the web UI. However, the more custom your setup, the less likely you'll be able to manage lower-level operations through the web UI. + +[[TOC]] + +Here are the four management levels we offer: + +## Level 4: Fully Managed on Your Cloud + +- **Description**: You only need to provide us with an API key from your preferred cloud provider, and we'll take care of the rest. We create machines, set up Kubernetes, and manage everything on your behalf. You don't even need an existing machine—all aspects are handled by us. Simply pay your cloud provider directly for the resources used. +- **Features**: + - Fully managed Kubernetes cluster on your cloud provider + - Machine creation, Kubernetes setup, and management handled by us + - Automatic connection to the Minekube web UI to manage everything + - No need to have an existing machine or run any commands + - Pay your cloud provider directly for resources used + +## Level 3: Bootstrapping a k3s Cluster by Command + +- **Description**: At this level, we provide documentation explaining how to bootstrap a k3s cluster with a single command and automatically connect to the Minekube web UI. We control everything, from installing Kubernetes properly to node upgrades and deploying our controllers. This is the most managed level, offering simplicity and ease of use. +- **Features**: + - Single command to set up a Kubernetes cluster using k3s + - Automatic connection to the Minekube web UI to manage everything + - Handled by us: installation, node upgrades, deployment of controllers, and more + +## Level 2: Admin Access to Your Cluster + +- **Description**: For users who want to choose how their Kubernetes cluster is set up. You maintain admin access to your Kubernetes API, allowing you to use our Minekube web UI seamlessly. While we handle the deployment and management of our controllers, as well as software updates and UI integration, you're responsible for node upgrades. We don't handle lower-level Kubernetes operations at this level. +- **Features**: + - More control over your Kubernetes cluster + - Convenience of using our Minekube web UI to manage everything except kubernetes nodes + - Handled by us: deployment and management of controllers, software updates, and integration with our UI + - Responsible for node upgrades + +## Level 1: Raw Control with Minimum Management + +- **Description**: This level is for users who desire the most raw control. You're responsible for ensuring our Minekube controllers are installed and kept updated on your cluster. We only handle core tasks necessary for you to manage game servers through our Minekube web UI. There's minimal management from our side—no controller updates, no node updates, just essential support for UI integration. +- **Features**: + - Most control over your Kubernetes cluster + - Convenience of using our Minekube web UI to manage game servers only + - Responsible for installing and updating our controllers, node updates, and other lower-level Kubernetes operations + - Handled by us: core tasks necessary to allow you to manage game servers through our Minekube web UI + +## Getting Started + +To get started, choose the management level that's right for you. We recommend starting with Level 1 if you're new to Kubernetes or want a simple and easy way to set up a cluster. If you want more control over your cluster, consider Level 2 or Level 3. And if you want a fully managed Kubernetes cluster on your cloud provider, choose Level 4. + +Once you've chosen your management level, follow the instructions on the corresponding subdoc page to get started. If you have any questions or need help, don't hesitate to contact us. + diff --git a/.web/docs/games/hosting/provider.md b/.web/docs/games/hosting/provider.md new file mode 100644 index 0000000..6bc0382 --- /dev/null +++ b/.web/docs/games/hosting/provider.md @@ -0,0 +1,17 @@ +# Using a Managed Provider for Minekube Games + +If you want to skip the hassle of managing infrastructure, a Minekube Games managed provider is the perfect solution. This option allows you to create and maintain your game server with ease, without needing to worry about the technical details of server management. + +## Advantage of Managed Providers + +- **Speed of Setup**: Launch your game servers quickly with pre-configured settings. +- **Reduced Maintenance**: Let the provider handle updates, backups, and security. +- **Support**: Access professional support and services to keep your server running smoothly. + +## How to Get Started + +- **Select a Provider**: Choose from a list of Minekube-approved game server providers. +- **Customize Your Server**: Pick your game, configure server settings, and get ready to launch. +- **One-Click Management**: Utilize the provider's dashboard to manage your game server, apply updates, and more. + +Explore below to find out more about choosing a Minekube Games managed provider and getting your server online today. \ No newline at end of file