Merge branch 'main' into search-applications-by-instances-and-devices

FlowFuse · Jul 11, 2024 · 6985fe0 · 6985fe0
2 parents 03457d8 + b29c425
commit 6985fe0
Show file tree

Hide file tree

Showing 35 changed files with 71 additions and 1 deletion.
diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Administering FlowFuse
 navOrder: 1
+meta:
+  descriptions: Learn how to administer FlowFuse with this comprehensive guide. Explore user management, team setup, instance and stack management, and more.
 ---
 # Administering FlowFuse
 

diff --git a/docs/admin/monitoring.md b/docs/admin/monitoring.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Monitoring
+meta:
+   description: Learn how to monitor statistical information about your FlowFuse platform using the API endpoint.
 ---
 
 # Platform Monitoring

diff --git a/docs/admin/sso/ldap.md b/docs/admin/sso/ldap.md
@@ -1,5 +1,7 @@
 ---
 navTitle: LDAP SSO
+meta:
+   description: Learn how to configure LDAP-based Single Sign-On (SSO) on FlowFuse's self-hosted Enterprise instances.
 ---
 
 # Configuring LDAP based Single Sign-On

diff --git a/docs/admin/sso/saml.md b/docs/admin/sso/saml.md
@@ -1,5 +1,7 @@
 ---
 navTitle: SAML SSO
+meta:
+   description: Learn how to configure SAML-based Single Sign-On (SSO) on FlowFuse's self-hosted Enterprise instances.
 ---
 
 # Configuring SAML based Single Sign-On

diff --git a/docs/admin/telemetry.md b/docs/admin/telemetry.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Telemetry
+meta:
+  description: Learn how FlowFuse collects anonymous usage information to improve platform performance without compromising user privacy.
 ---
 
 # Usage Telemetry

diff --git a/docs/admin/user_management.md b/docs/admin/user_management.md
@@ -1,5 +1,7 @@
 ---
 navTitle: User Management
+meta:
+  description: Explore effective user management on FlowFuse, covering registration, user creation, password management, and team ownership.
 ---
 
 # User management

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -2,6 +2,8 @@
 navGroup: FlowFuse User Manuals
 navOrder: 2
 navTitle: FlowFuse API
+meta:
+  description: Explore the FlowFuse Platform API, a RESTful interface that facilitates custom integrations, workflows, and interactions.
 ---
 
 # FlowFuse Platform API

diff --git a/docs/cloud/billing.md b/docs/cloud/billing.md
@@ -1,5 +1,7 @@
 ---
 navTitle: FlowFuse Cloud Billing
+meta:
+  description: Learn about billing details for FlowFuse Cloud, including payment methods, team billing, billing cycles, managing instances, handling failed payments, and cancelling subscriptions.
 ---
 
 # Billing

diff --git a/docs/cloud/introduction.md b/docs/cloud/introduction.md
@@ -1,6 +1,8 @@
 ---
 navOrder: 1
 navTitle: Introduction
+meta:
+  description: Learn about FlowFuse Cloud, a hosted service for effortless Node-RED instance management. Discover features, billing, support options, and more in our comprehensive documentation.
 ---
 
 # FlowFuse Cloud

diff --git a/docs/contribute/workflows/README.md b/docs/contribute/workflows/README.md
@@ -1,5 +1,7 @@
 ---
 navTitle: State Flows
+meta:
+   description: Explore key workflows in FlowFuse Cloud with detailed sequence diagrams, covering login, user sign-up, password reset, and more.
 ---
 
 # Workflows

diff --git a/docs/contribute/workflows/device-editor.md b/docs/contribute/workflows/device-editor.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Device Editor
+meta:
+   description: Explore how to enable and use the device editor in FlowFuse Cloud with detailed sequence diagrams and instructions.
 ---
 
 # Enabling the device editor

diff --git a/docs/contribute/workflows/invite-external-user.md b/docs/contribute/workflows/invite-external-user.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Invite External Users
+meta:
+   description: Learn how to invite external users to your team in FlowFuse Cloud. Follow our guide with clear steps and diagrams for seamless collaboration.
 ---
 
 # Invite External User Flow

diff --git a/docs/contribute/workflows/login.md b/docs/contribute/workflows/login.md
@@ -1,5 +1,7 @@
 ---
 navTitle: User Login Flows
+meta:
+   description: Learn user login flows in FlowFuse Cloud with clear diagrams and explanations.
 ---
 
 # User Login Flows

diff --git a/docs/contribute/workflows/password-reset.md b/docs/contribute/workflows/password-reset.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Reset Password Flow
+meta:
+   description: Learn how to reset passwords in FlowFuse Cloud with our step-by-step guide and detailed sequence diagrams.
 ---
 
 # Reset Password Flow

diff --git a/docs/contribute/workflows/project-create.md b/docs/contribute/workflows/project-create.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Project Creation
+meta:
+  description: Discover how to create projects in FlowFuse Cloud with a clear sequence diagram. Learn about billing and non-billing scenarios.
 ---
 
 # Sequence For Project Creation

diff --git a/docs/contribute/workflows/project-states.md b/docs/contribute/workflows/project-states.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Instance states
+meta:
+  description: Learn about Node-RED instance states in FlowFuse Cloud, from starting and running to safe mode and suspension, with a concise state diagram.
 ---
 
 # States

diff --git a/docs/contribute/workflows/signup.md b/docs/contribute/workflows/signup.md
@@ -1,5 +1,7 @@
 ---
 navTitle: User Sign up Flow
+meta:
+   description: Learn how users sign up for FlowFuse Cloud accounts with a detailed sequence diagram outlining the process from registration to email verification.
 ---
 
 # User Sign Up Flow

diff --git a/docs/contribute/workflows/team-create.md b/docs/contribute/workflows/team-create.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Team creation Flow
+meta:
+   description: Explore the detailed sequence for team creation in FlowFuse with step-by-step process diagrams, covering both billing-enabled and no-billing scenarios, ensuring a comprehensive understanding of the workflow.
 ---
 
 # Sequence For Team Creation

diff --git a/docs/debugging/README.md b/docs/debugging/README.md
@@ -1,6 +1,8 @@
 ---
 navGroup: Support
 navTitle: Debugging Node-RED issues
+meta:
+   description: Learn how to troubleshoot unresponsive Node-RED instances using Safe Mode.
 ---
 
 # Node-RED Safe Mode

diff --git a/docs/device-agent/deploy.md b/docs/device-agent/deploy.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Deploying your Flows
 navOrder: 6
+meta:
+   description: Learn how to deploy Node-RED flows to devices using FlowFuse, enabling seamless development and deployment processes.
 ---
 
 # Deploying Flows to the Device Agent - Team and Enterprise tier only

diff --git a/docs/device-agent/install.md b/docs/device-agent/install.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Installation
 navOrder: 3
+meta: 
+   description: Explore step-by-step instructions to install and configure the FlowFuse Device Agent on various platforms, ensuring seamless connectivity with FlowFuse Cloud and MQTT services.
 ---
 
 # Installing Device Agent

diff --git a/docs/device-agent/introduction.md b/docs/device-agent/introduction.md
@@ -1,6 +1,8 @@
 ---
 navTitle: FlowFuse Device Agent Introduction
 navOrder: 1
+meta:
+   description: Learn how to effectively manage Node-RED instances on remote devices using FlowFuse's powerful Device Agent, enabling seamless deployment and management through the FlowFuse platform.
 ---
 
 # FlowFuse Device Agent

diff --git a/docs/device-agent/quickstart-web-ui.md b/docs/device-agent/quickstart-web-ui.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Quick Start with Web UI
 navOrder: 3
+meta:
+   description: Learn how to add devices and develop workflows using FlowFuse web UI on Devices.
 ---
 
 # Developing Flows on Your Device

diff --git a/docs/device-agent/quickstart.md b/docs/device-agent/quickstart.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Quick Start
 navOrder: 2
+meta:
+   description: Learn how to add and connect devices to FlowFuse, and develop workflows using the web UI.
 ---
 
 # Developing Flows on Your Device

diff --git a/docs/device-agent/register.md b/docs/device-agent/register.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Register your Device
 navOrder: 4
+meta:
+   description: Learn how to register devices with FlowFuse using single and bulk registration methods. Follow step-by-step instructions for generating configurations, connecting devices, assigning to applications or instances, and troubleshooting.
 ---
 
 # Register your Device

diff --git a/docs/device-agent/running.md b/docs/device-agent/running.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Running the Agent
 navOrder: 5
+meta:
+   description: Explore how to run and configure the FlowFuse Device Agent, covering startup commands, port settings, HTTP proxy setup, and offline module caching.
 ---
 
 # Running the Device Agent

diff --git a/docs/hardware/ctrlx-device-agent.md b/docs/hardware/ctrlx-device-agent.md
@@ -1,6 +1,8 @@
 ---
 navTitle: ctrlX - Device Agent
 navOrder: 3
+meta:
+   description: Learn to install and configure the FlowFuse Device Agent on ctrlX devices for seamless integration with FlowFuse, ensuring efficient device management.
 ---
 # ctrlX Device Agent App
 

diff --git a/docs/hardware/ctrlx-node-red.md b/docs/hardware/ctrlx-node-red.md
@@ -1,6 +1,8 @@
 ---
 navTitle: ctrlX - Node-RED
 navOrder: 2
+meta:
+   description: Discover how to install, log in, and create Node-RED flows on ctrlX devices with the Rexroth CtrlX App by FlowFuse.
 ---
 # ctrlX Node-RED App
 

diff --git a/docs/hardware/introduction.md b/docs/hardware/introduction.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Overview
 navOrder: 1
+meta:
+   description: Discover hardware-specific installation guides for the FlowFuse Device Agent on supported platforms like Bosch Rexroth's ctrlX and Raspberry Pi.
 ---
 
 # Device Agent - Hardware

diff --git a/docs/hardware/raspbian.md b/docs/hardware/raspbian.md
@@ -1,6 +1,8 @@
 ---
 navTitle: Raspberry Pi with Raspbian
 navOrder: 3
+meta: 
+   description: Learn how to Install and configure FlowFuse Device Agent on Raspberry Pi with Raspbian for seamless device management and automation using our step-by-step guide and installation script.
 ---
 
 # Raspberry Pi

diff --git a/docs/install/docker/README.md b/docs/install/docker/README.md
@@ -1,5 +1,7 @@
 ---
-navTitle: Docker install
+navTitle: Docker install\
+meta:
+   description: Learn how to install FlowFuse using Docker Compose for on-premise deployments. Configure DNS, manage Node-RED instances, and set up HTTPS with Let's Encrypt or wildcard TLS certificates
 ---
 
 # Docker Install

diff --git a/docs/install/docker/aws-marketplace.md b/docs/install/docker/aws-marketplace.md
@@ -1,5 +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.
 ---
 
 # Installing FlowFuse from AWS Market Place

diff --git a/docs/install/docker/digital-ocean.md b/docs/install/docker/digital-ocean.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Docker on Digital Ocean
+meta:
+   description: Deploy FlowFuse on Digital Ocean Droplets with Docker Compose effortlessly. Set up DNS, configure SMTP, and manage Node-RED applications seamlessly.
 ---
 
 # 1-Click Digital Ocean Droplet Install

diff --git a/docs/install/docker/stacks.md b/docs/install/docker/stacks.md
@@ -1,5 +1,7 @@
 ---
 navTitle: Add Project Stacks on Docker
+meta:
+   description: Configure Node-RED containers with Docker Stacks. Customize memory, CPU, and container images like flowfuse/node-red:latest.
 ---
 
 # Docker Stacks

diff --git a/docs/install/file-storage/README.md b/docs/install/file-storage/README.md
@@ -1,5 +1,7 @@
 ---
 navTitle: FlowFuse File Storage
+meta:
+   description: Explore FlowFuse v2.6.0's Persistent Storage for Kubernetes and Docker. Configure Node-RED's persistent volumes and manage File Storage and Persistent Context efficiently.
 ---
 
 # FlowFuse File Storage