add meta-information to docs

FlowFuse · Jul 12, 2024 · 22fe9fa · 22fe9fa
1 parent ddd6a35
commit 22fe9fa
Show file tree

Hide file tree

Showing 19 changed files with 37 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Documentation
+meta:
+   description: Explore comprehensive documentation for FlowFuse, covering user manuals, API references, Node-RED migration guides, device management, FlowFuse Cloud setup, self-hosted installations, support resources, and contributing to FlowFuse development.
 ---
 
 # FlowFuse Documentation

diff --git a/docs/install/configuration.md b/docs/install/configuration.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Configuring FlowFuse
+meta:
+   description: Customize FlowFuse platform settings for server, database, Node-RED deployment, MQTT, email, and more with detailed configuration options.
 ---
 
 # Configuring FlowFuse

diff --git a/docs/install/dns-setup.md b/docs/install/dns-setup.md
@@ -1,5 +1,7 @@
 ---
 navTitle: DNS Setup
+meta:
+   description: Discover DNS setup for FlowFuse on Docker or Kubernetes. Learn production and local testing methods using dnsmasq, AWS ALB Ingress, Digital Ocean, and Pi Hole
 ---
 
 # DNS Setup

diff --git a/docs/install/docker/aws-marketplace.md b/docs/install/docker/aws-marketplace.md
@@ -1,7 +1,7 @@
 ---
 navTitle: Docker from AWS Market Place
 meta: 
-    description: Deploy FlowFuse on AWS EC2 using Docker from our AWS Marketplace AMI. Setup DNS and optional SMTP for seamless management of applications and Node-RED instances.
+   description: Deploy FlowFuse on AWS EC2 using Docker from our AWS Marketplace AMI. Setup DNS and optional SMTP for seamless management of applications and Node-RED instances.
 ---
 
 # Installing FlowFuse from AWS Market Place

diff --git a/docs/install/email_providers.md b/docs/install/email_providers.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Email configuration
+meta:
+   description: Explore YAML configurations for GMail and Office365 email setups in FlowFuse, including SMTP server settings and authentication.
 ---
 
 ## Example configuration for common email platforms

diff --git a/docs/install/first-run.md b/docs/install/first-run.md
@@ -1,5 +1,7 @@
 ---
 navTitle: First Run Setup
+meta:
+   descripition: Get started with FlowFuse using our concise first-run setup guide, covering initial access, administrator creation, license uploading, and platform setup.
 ---
 
 # First-run Setup

diff --git a/docs/install/introduction.md b/docs/install/introduction.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Overview
 navOrder: 1
+meta:
+   description: Install and manage FlowFuse on Linux, Windows, and MacOS. Explore deployment models, request a trial license, and find Docker and Kubernetes setup guides. Start with FlowFuse today!
 ---
 # Installing FlowFuse
 

diff --git a/docs/install/kubernetes/README.md b/docs/install/kubernetes/README.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Install FlowFuse on Kubernetes
+meta: 
+   description: Install FlowFuse on Kubernetes using Helm charts for easy configuration and management. Ensure efficient data storage and enable MQTT broker integration seamlessly.
 ---
 
 # Kubernetes Install

diff --git a/docs/install/kubernetes/aws.md b/docs/install/kubernetes/aws.md
@@ -1,5 +1,7 @@
 ---
 navTitle: AWS EKS Installation
+meta:
+   description: Learn how to install FlowFuse on AWS EKS with setup details for EKS, Nginx Ingress, AWS SES, and RDS PostgreSQL integration.
 ---
 
 # AWS EKS Specific details

diff --git a/docs/install/kubernetes/aws_terraform.md b/docs/install/kubernetes/aws_terraform.md
@@ -1,5 +1,7 @@
 ---
 navTitle: AWS EKS Installation with Terraform and Helm
+meta:
+   description: Learn to deploy FlowFuse on AWS EKS using Terraform and Helm. Setup VPC, EKS, RDS, Route53, SES, and Nginx Ingress Controller step-by-step.
 ---
 
 # FlowFuse-oriented infrastructure in AWS using Terraform and Helm

diff --git a/docs/install/kubernetes/digital-ocean.md b/docs/install/kubernetes/digital-ocean.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Digital Ocean Kubernetes Installation
+meta:
+   description: Install FlowFuse on Digital Ocean Kubernetes with cluster setup, Nginx Ingress, SSL using Cert-manager, and Helm deployment.
 ---
 
 # Installing FlowFuse on a Digital Ocean Kubernetes cluster

diff --git a/docs/install/kubernetes/stacks.md b/docs/install/kubernetes/stacks.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Kubernetes Project Stacks
+meta:
+   description: Discover Kubernetes stacks for Node-RED instances with Helm charts. Customize memory, CPU, and container configurations using Docker for seamless FlowFuse integration.
 ---
 
 # Kubernetes Stacks

diff --git a/docs/install/local/README.md b/docs/install/local/README.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Local Install
+meta:
+   description: Learn how to install FlowFuse locally on various operating systems, including setup instructions for Node.js and configuring the platform without HTTPS support.
 ---
 
 # Local Install

diff --git a/docs/install/local/stacks.md b/docs/install/local/stacks.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Local Stacks
+meta:
+   description: Configure Node-RED instances with custom memory limits and versions using Stacks in FlowFuse for local deployments.
 ---
 
 # Local Stacks

diff --git a/docs/migration/introduction.md b/docs/migration/introduction.md
@@ -1,6 +1,8 @@
 ---
 navOrder: 1
 navTitle: Introduction
+meta:
+   description: Guide to migrating Node-RED applications to FlowFuse, covering flows, credentials, environment variables, and handling static files.
 ---
 
 # Migrating a Node-RED application to FlowFuse 

diff --git a/docs/migration/node-red-tools.md b/docs/migration/node-red-tools.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Node-RED Tools plugin
+meta:
+   description: Learn to manage Node-RED flows seamlessly with the FlowFuse Node-RED Tools plugin, enabling easy creation and deployment of instance snapshots from your local environment.
 ---
 
 # FlowFuse Node-RED Tools plugin

diff --git a/docs/premium-support.md b/docs/premium-support.md
@@ -2,6 +2,8 @@
 navGroup: Support
 navOrder: 3
 navTitle: Premium Support
+meta:
+   description: Get premium customer support for FlowFuse application and account-related issues by filing a ticket.
 ---
 # Customer Support
 

diff --git a/docs/upgrade/README.md b/docs/upgrade/README.md
@@ -2,6 +2,8 @@
 navGroup: FlowFuse Self-Hosted
 navOrder: 2
 navTitle: Upgrading FlowFuse
+meta:
+   description: Learn how to upgrade your FlowFuse instance with detailed guidelines for LocalFS, Docker, and Kubernetes deployments.
 ---
 
 # Upgrading FlowFuse

diff --git a/docs/upgrade/open-source-to-premium.md b/docs/upgrade/open-source-to-premium.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Installing a license
+meta:
+   description: Upgrade your self-managed FlowFuse installation with enterprise features by uploading a license and enabling FlowFuse Authentication for Node-RED plugins.
 ---
 
 ## Upgrading to FlowFuse Enterprise