Merge pull request #8 from brainpodnl/feat/extend-docs-with-newest-resources-and-blueprints

feat: extend docs with newest resources and blueprints

Author: Rick-VA

_config.ts

@@ -1,13 +1,16 @@
 import lume from "lume/mod.ts";
 import wiki from "wiki/mod.ts";
 import tailwindcss from "lume/plugins/tailwindcss.ts";
+import metas from "lume/plugins/metas.ts";
 
 const site = lume({
   src: "./src",
   dest: "./_site",
+  location: new URL("https://docs.brainpod.io"),
 });
 
 site.use(wiki());
 site.use(tailwindcss());
+site.use(metas());
 
 export default site;

src/_data.yml

@@ -1,2 +1,7 @@
 logo: /PRIMARY.png
 menu_links: []
+
+metas:
+  site: Brainpod Docs
+  lang: en
+  robots: "index, follow"

src/background-information.md

@@ -1,6 +1,9 @@
 ---
 order: 5
 hide_menu: false
+metas:
+  description: "Background on cloud-native principles, containers, and Kubernetes that power Brainpod. Understand the technology behind the platform before you start deploying."
+  keywords: ["cloud-native", "containers", "Kubernetes", "Docker", "container orchestration", "Brainpod background"]
 ---
 # Background information
 
@@ -48,4 +51,4 @@ Brainpod embraces cloud-native principles while keeping things simple. You build
 
 ## Next Steps
 
-- [Brainpod Concepts](brainpod.md) – Brainpod Concepts
+- [Brainpod Concepts](brainpod.md): Brainpod Concepts

src/blueprints.md

@@ -0,0 +1,21 @@
+---
+order: 4
+hide_menu: false
+metas:
+  description: "Brainpod Blueprints are pre-configured deployment setups for popular applications like WordPress, PocketBase, and Next.js. Get up and running fast."
+  keywords: ["Brainpod blueprints", "WordPress hosting", "PocketBase deployment", "Next.js hosting", "pre-configured apps"]
+---
+# Blueprints
+
+Blueprints are pre-configured setups for common applications on Brainpod. Each blueprint walks you through deploying a specific stack with the right resources and configuration.
+
+## Available Blueprints
+
+- **[WordPress](blueprints/wordpress.md)**: Deploy a WordPress site with a managed database
+- **[PocketBase](blueprints/pocketbase.md)**: Run a self-hosted PocketBase backend
+- **[Next.js](blueprints/nextjs.md)**: Deploy a Next.js application
+
+## Next Steps
+
+- [Brainpod Resources](resources.md): Learn about the available resource types
+- [Getting Started](getting-started.md): Deploy your first app

src/blueprints/nextjs.md

@@ -0,0 +1,54 @@
+---
+order: 3
+hide_menu: false
+metas:
+  description: "Deploy a Next.js application on Brainpod. Connect your GitHub repository and Brainpod automatically builds and deploys your app using Railpack."
+  keywords: ["Next.js Brainpod", "deploy Next.js", "Next.js hosting", "React framework", "GitHub Actions"]
+---
+# Next.js
+
+The Next.js blueprint sets up the infrastructure to run your Next.js application on Brainpod and wires it to your GitHub repository. Every push to your main branch automatically builds and deploys your app. No Dockerfile required: Brainpod uses [Railpack](https://github.com/railwayapp/railpack) to detect your framework and build the image for you.
+
+## What Gets Deployed
+
+The blueprint creates the following resources in your pod:
+
+- **1 App**: configured for Next.js on port 3000, with `NODE_ENV` set to `production`
+- **1 Route**: a public hostname under `*.route.brainpod.io` with automatic TLS
+
+Next.js is stateless by default, so no disk is needed. If your app writes files to disk (e.g. for uploads), add a Disk resource and mount it to your app after deploying the blueprint.
+
+## Deploying the Blueprint
+
+1. Go to your pod in the Brainpod dashboard
+2. Navigate to **Blueprints**
+3. Select **Next.js**
+4. Give your deployment a name (e.g. `web`): this prefixes all created resources
+5. Click **Deploy**
+
+The blueprint deploys with a placeholder image. Your app will not serve real content until you connect your GitHub repository.
+
+## Connecting Your GitHub Repository
+
+Brainpod uses GitHub Actions and Railpack to build your app automatically on every push.
+
+1. Open the **App** resource created by the blueprint
+2. Go to the **Image Source** tab and select **GitHub Auto-Deploy**
+3. Select your GitHub repository and branch
+4. Click **Connect**: Brainpod opens a pull request in your repository that adds:
+   - `steiger.yml`: the Railpack build configuration
+   - `.github/workflows/deploy-to-brainpod.yml`: the GitHub Actions workflow
+5. Merge the pull request
+
+From this point on, every push to your configured branch triggers a build. Railpack detects your Next.js project automatically, builds a container image, pushes it to the Brainpod registry, and your app is redeployed with the new image.
+
+## Monitoring Builds
+
+You can follow the progress of each build in the **Builds** section of your pod. Each build shows its status, logs, and the artifact it produced. When a build completes successfully, the app switches to the new image automatically.
+
+## Next Steps
+
+- [Custom domains](../custom_domains.md): Point your own domain to your app
+- [Apps](../resources/apps.md): Configure environment variables, scaling, and more
+- [Container Registry](../registry.md): Learn about how images are stored
+- [Blueprints](../blueprints.md): Browse other available blueprints

src/blueprints/pocketbase.md

@@ -0,0 +1,56 @@
+---
+order: 2
+hide_menu: false
+metas:
+  description: "Run a self-hosted PocketBase backend on Brainpod. Deploy PocketBase as a containerized app with persistent storage and a public route."
+  keywords: ["PocketBase Brainpod", "self-hosted PocketBase", "deploy PocketBase", "backend as a service", "BaaS"]
+---
+# PocketBase
+
+The PocketBase blueprint deploys a self-hosted PocketBase backend on Brainpod. PocketBase gives you a realtime database, authentication, file storage, and an admin UI: all in a single app. Brainpod handles the infrastructure.
+
+## What Gets Deployed
+
+The blueprint creates the following resources in your pod:
+
+- **1 Disk**: persistent storage for your PocketBase data at `/pb_data`
+- **1 App**: PocketBase v0.36.7 running on port 8090
+- **1 Route**: a public hostname under `*.route.brainpod.io` with automatic TLS
+
+## Deploying the Blueprint
+
+1. Go to your pod in the Brainpod dashboard
+2. Navigate to **Blueprints**
+3. Select **PocketBase**
+4. Give your deployment a name (e.g. `backend`): this prefixes all created resources
+5. Click **Deploy**
+
+Brainpod creates all resources and deploys them. Once the deployment is complete, you need to create your first superuser account before you can use the admin UI.
+
+## Creating Your Superuser Account
+
+PocketBase generates a one-time setup link the first time it starts. To find it:
+
+1. Go to your pod in the Brainpod dashboard
+2. Open the **Events** page for your PocketBase app
+3. Look for a log line that contains a link like:
+
+```
+http://0.0.0.0:8090/_/#/pbinstal/...
+```
+
+4. Copy that URL and replace `0.0.0.0:8090` with your Brainpod hostname (shown on your Route)
+
+The final URL will look like:
+
+```
+https://your-hostname.route.brainpod.io/_/#/pbinstal/...
+```
+
+Open that URL in your browser to create your superuser account. After completing the setup you have full access to the PocketBase admin UI at `https://your-hostname.route.brainpod.io/_/`.
+
+## Next Steps
+
+- [Custom domains](../custom_domains.md): Point your own domain to your PocketBase instance
+- [Disks](../resources/disks.md): Learn about the persistent storage backing your data
+- [Blueprints](../blueprints.md): Browse other available blueprints

src/blueprints/wordpress.md

@@ -0,0 +1,48 @@
+---
+order: 1
+hide_menu: false
+metas:
+  description: "Deploy WordPress on Brainpod with a managed MariaDB database and persistent storage. Step-by-step blueprint for a production-ready WordPress installation."
+  keywords: ["WordPress Brainpod", "deploy WordPress", "WordPress hosting", "managed WordPress", "self-hosted WordPress"]
+---
+# WordPress
+
+The WordPress blueprint deploys a complete WordPress stack on Brainpod in one step. It sets up everything you need: a managed database, persistent storage for your files, the WordPress app, and a public route with automatic HTTPS.
+
+## What Gets Deployed
+
+The blueprint creates the following resources in your pod:
+
+- **2 Disks**: one for the database, one for your WordPress files and uploads
+- **1 MariaDB**: a managed MySQL-compatible database that WordPress connects to automatically
+- **1 App**: WordPress 6.9 running on PHP 8.2 with Apache
+- **1 Route**: a public hostname under `*.route.brainpod.io` with automatic TLS
+
+The database connection is wired up automatically. You do not need to configure `WORDPRESS_DB_HOST`, `WORDPRESS_DB_USER`, `WORDPRESS_DB_PASSWORD`, or `WORDPRESS_DB_NAME` yourself.
+
+## Deploying the Blueprint
+
+1. Go to your pod in the Brainpod dashboard
+2. Navigate to **Blueprints**
+3. Select **WordPress**
+4. Give your deployment a name (e.g. `myblog`): this prefixes all created resources
+5. Click **Deploy**
+
+Brainpod creates all resources and deploys them. Once the deployment is complete, open the hostname shown on your Route. You will be greeted by the WordPress setup wizard.
+
+## Finishing the WordPress Setup
+
+The first time you visit your WordPress URL, the setup wizard walks you through:
+
+1. Choosing a language
+2. Setting your site title
+3. Creating your admin username and password
+
+After completing the wizard you are taken to the WordPress dashboard and your site is live.
+
+## Next Steps
+
+- [Custom domains](../custom_domains.md): Point your own domain to your WordPress site
+- [Container Registry](../registry.md): Push a custom image if you need plugins pre-installed
+- [Disks](../resources/disks.md): Learn about the persistent storage backing your site
+- [Blueprints](../blueprints.md): Browse other available blueprints

src/brainpod.md

@@ -1,6 +1,9 @@
 ---
 order: 0
 hide_menu: false
+metas:
+  description: "Learn about Brainpod's core concepts: pods, resources, and revisions. A git-like interface for your cloud infrastructure without the Kubernetes complexity."
+  keywords: ["Brainpod concepts", "pods", "resources", "revisions", "infrastructure management", "cloud-native"]
 ---
 # Brainpod Concepts
 
@@ -16,14 +19,14 @@ Pods give you clear boundaries and ownership. Development stays separate from pr
 
 ## Resources
 
-We use a resource model to represent your infrastructure. Each resource is a high-level abstraction—a single resource might map to dozens of underlying components like deployments, services, load balancers, and configurations.
+We use a resource model to represent your infrastructure. Each resource is a high-level abstraction-a single resource might map to dozens of underlying components like deployments, services, load balancers, and configurations.
 
 You work at a much higher level than traditional cloud providers. Instead of configuring individual pieces, you simply define an app and a route. The platform handles the complexity.
 
 Currently, we support two resource types:
 
-- **[Apps](resources/apps.md)** — Your containerized applications
-- **[Routes](resources/routes.md)** — HTTP/HTTPS routing to your apps
+- **[Apps](resources/apps.md)**: Your containerized applications
+- **[Routes](resources/routes.md)**: HTTP/HTTPS routing to your apps
 
 Learn more in the [Resources documentation](resources.md).
 
@@ -61,7 +64,7 @@ Your team sees the complete history, can roll back if needed, and collaborates o
 
 Ready to work with specific resource types and start building?
 
-- [Resources](resources.md) – Learn about Apps and Routes in detail
-- [Getting Started](getting-started.md) – Deploy your first application
-- [Working with the Dashboard](dashboard.md) – Navigate the interface
-- [background information](background-information.md) – Review the foundation
+- [Resources](resources.md): Learn about Apps and Routes in detail
+- [Getting Started](getting-started.md): Deploy your first application
+- [Working with the Dashboard](dashboard.md): Navigate the interface
+- [background information](background-information.md): Review the foundation

src/custom_domains.md

@@ -1,6 +1,9 @@
 ---
 order: 4
 hide_menu: false
+metas:
+  description: "Add custom domains to your Brainpod routes. Configure DNS, get automatic TLS certificates, and serve your apps from any domain you own."
+  keywords: ["Brainpod custom domains", "DNS configuration", "TLS certificate", "HTTPS", "CNAME", "custom hostname"]
 ---
 # Custom domains
 
@@ -35,12 +38,12 @@ CNAME records automatically follow any infrastructure changes on our side, so yo
 
 ## Multiple Custom Domains
 
-A single route can have multiple custom domains. This is useful when you want several domains pointing to the same application—for example, `www.example.com` and `app.example.com`, or multiple brand domains.
+A single route can have multiple custom domains. This is useful when you want several domains pointing to the same application-for example, `www.example.com` and `app.example.com`, or multiple brand domains.
 
 To add multiple domains, simply add each domain when creating or editing your route configuration. After deploying, configure DNS records for each domain separately in your DNS provider.
 
 Each domain gets its own TLS certificate and verification status on the Domains page. All domains on a route use the same routing rules and point to the same apps.
 
 ## Next Steps
-- [Resources](resources.md) — Learn about apps and routes
-- [Getting Started](getting-started.md) — Deploy your first application
+- [Resources](resources.md): Learn about apps and routes
+- [Getting Started](getting-started.md): Deploy your first application