From 22fe9fa1ede007b31661fdad1df4b8f2c0159722 Mon Sep 17 00:00:00 2001 From: "sumit shinde ( Roni )" Date: Fri, 12 Jul 2024 22:29:54 +0530 Subject: [PATCH] add meta-information to docs --- docs/README.md | 2 ++ docs/install/configuration.md | 2 ++ docs/install/dns-setup.md | 2 ++ docs/install/docker/aws-marketplace.md | 2 +- docs/install/email_providers.md | 2 ++ docs/install/first-run.md | 2 ++ docs/install/introduction.md | 2 ++ docs/install/kubernetes/README.md | 2 ++ docs/install/kubernetes/aws.md | 2 ++ docs/install/kubernetes/aws_terraform.md | 2 ++ docs/install/kubernetes/digital-ocean.md | 2 ++ docs/install/kubernetes/stacks.md | 2 ++ docs/install/local/README.md | 2 ++ docs/install/local/stacks.md | 2 ++ docs/migration/introduction.md | 2 ++ docs/migration/node-red-tools.md | 2 ++ docs/premium-support.md | 2 ++ docs/upgrade/README.md | 2 ++ docs/upgrade/open-source-to-premium.md | 2 ++ 19 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index b559630fb0..686a7b6ba1 100644 --- 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 index 5fe90b5c77..6236e66571 100644 --- 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 index 159e18119f..fb8d6227b1 100644 --- 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 index d064dd4b79..6b41148ea0 100644 --- 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 index f1a3bade76..fd3a62ebda 100644 --- 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 index f8b312338f..607c02fb24 100644 --- 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 index d4eeb3392c..7cfdf6eac6 100644 --- 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 index f32fcc6f28..6bda6ebf78 100644 --- 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 index a519f33720..f6ac8f85f3 100644 --- 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 index 7c7859773e..a032078e42 100644 --- 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 index 4a0eef8845..b4e416b68c 100644 --- 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 index bc280cab67..36a555665a 100644 --- 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 index 155d488ea2..0c3b90a4aa 100644 --- 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 index 239349e6c2..63b112e3ec 100644 --- 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 index 60808135c5..4888e7a1d5 100644 --- 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 index 1e4b078e55..3d3258e6e5 100644 --- 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 index a8e7fae8ad..59568c1f78 100644 --- 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 index 2881cad40f..4d22bcf355 100644 --- 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 index 4498d6e0e5..eae6f0261c 100644 --- 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