Merge branch 'main' into 4381-invites-posthog

FlowFuse · Aug 27, 2024 · 5bfd259 · 5bfd259
2 parents 6688d69 + 572e808
commit 5bfd259
Show file tree

Hide file tree

Showing 66 changed files with 824 additions and 45 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,18 @@
 ---
 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.
+   tags:
+      - flowfuse
+      - nodered
+      - documentation
+      - api
+      - migration
+      - device management
+      - cloud
+      - self-hosted
+      - support
+      - contributing
 ---
 
 # FlowFuse Documentation

diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md
@@ -3,6 +3,15 @@ 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.
+  tags:  
+     - flowfuse
+     - nodered 
+     - user management
+     - team setup
+     - instance management
+     - stack management
+     - platform administration
+     - security
 ---
 # Administering FlowFuse
 

diff --git a/docs/admin/monitoring.md b/docs/admin/monitoring.md
@@ -2,6 +2,15 @@
 navTitle: Monitoring
 meta:
    description: Learn how to monitor statistical information about your FlowFuse platform using the API endpoint.
+   tags:
+      - flowfuse
+      - nodered
+      - monitoring
+      - api
+      - prometheus
+      - platform statistics
+      - token-based access
+      - securing nodered
 ---
 
 # Platform Monitoring

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

diff --git a/docs/admin/user_management.md b/docs/admin/user_management.md
@@ -2,6 +2,13 @@
 navTitle: User Management
 meta:
   description: Explore effective user management on FlowFuse, covering registration, user creation, password management, and team ownership.
+  tags:
+     - flowfuse
+     - nodered
+     - user management
+     - account setup
+     - password management
+     - team ownership
 ---
 
 # User management

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -3,7 +3,16 @@ 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.
+  description: Explore the FlowFuse Platform API, a RESTful interface that facilitates custom integrations, workflows, and interactions
+  tags:
+  - flowfuse
+  - nodered
+  - api
+  - integrations
+  - workflows
+  - rest api
+  - openapi
+  - access tokens
 ---
 
 # FlowFuse Platform API

diff --git a/docs/cloud/billing.md b/docs/cloud/billing.md
@@ -2,6 +2,18 @@
 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.
+  tags:
+  - flowfuse
+  - nodered
+  - billing
+  - payments
+  - subscription
+  - stripe
+  - instances
+  - team billing
+  - billing cycle
+  - failed payments
+  - account management 
 ---
 
 # Billing

diff --git a/docs/cloud/introduction.md b/docs/cloud/introduction.md
@@ -3,6 +3,16 @@ 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.
+  tags:
+  - flowfuse
+  - nodered
+  - cloud
+  - node-red
+  - instance management
+  - cloud instances
+  - SSO
+  - custom hostnames
+  - network
 ---
 
 # FlowFuse Cloud

diff --git a/docs/contribute/adding-template-settings.md b/docs/contribute/adding-template-settings.md
@@ -1,5 +1,16 @@
 ---
 navTitle: Adding Template Settings
+meta:
+   description: Learn how to add new runtime options to Node-RED templates in FlowFuse, including updates to frontend, runtime, and the launcher.
+   tags:
+      - flowfuse
+      - nodered
+      - contributing
+      - template
+      - settings
+      - frontend
+      - runtime
+      - launcher
 ---
 
 # Adding Template Settings

diff --git a/docs/contribute/api-design.md b/docs/contribute/api-design.md
@@ -1,5 +1,12 @@
 ---
 navTitle: API Design
+meta:
+   description: Detailed documentation on HTTP API design for the FlowFuse platform, including schema definitions, object IDs, route paths, and pagination.
+   tags:
+      - flowfuse
+      - nodered
+      - api
+      - contributing
 ---
 
 # HTTP API of the FlowFuse platform

diff --git a/docs/contribute/architecture.md b/docs/contribute/architecture.md
@@ -1,5 +1,15 @@
 ---
 navTitle: FlowFuse Architecture
+meta:
+   description: Overview of FlowFuse architecture and deployment options.
+   tags: 
+      - flowFuse
+      - architecture
+      - contributing
+      - nodered
+      - kubernetes
+      - docker
+      - container orchestration
 ---
 
 # FlowFuse Architecture

diff --git a/docs/contribute/creating-debug-stack-containers.md b/docs/contribute/creating-debug-stack-containers.md
@@ -1,5 +1,12 @@
 ---
 navTitle: Creating debug stack containers
+meta:
+   description: Guide for creating and using debug containers in FlowFuse without rebuilding from scratch.
+   tags:
+      - node-red
+      - flowfuse
+      - docker
+      - debugging
 ---
 
 Sometimes we want to be able to run some debug code within a stack running in our

diff --git a/docs/contribute/db-migrations.md b/docs/contribute/db-migrations.md
@@ -1,5 +1,12 @@
 ---
 navTitle: Database migrations
+meta:
+   description: Guide for creating and applying database migrations using custom tooling in FlowFuse.
+   tags:
+      - flowfuse
+      - contributing
+      - database
+      - migrations
 ---
 
 # Database Migrations

diff --git a/docs/contribute/feature-flags.md b/docs/contribute/feature-flags.md
@@ -1,5 +1,12 @@
 ---
 navTitle: Working with Feature Flags
+meta:
+   description: Guide for adding and using feature flags at the platform-wide and team type levels in FlowFuse.
+   tags:
+      - feature flags
+      - platform features
+      - flowfuse
+      - team types
 ---
 
 When adding features to the platform it is sometimes a requirement to be able to

diff --git a/docs/contribute/introduction.md b/docs/contribute/introduction.md
@@ -1,6 +1,12 @@
 ---
 navTitle: Introduction
 navOrder: 1
+meta:
+   description: This guide provides detailed instructions on how to contribute to the FlowFuse project, including setup, development, and testing processes.
+   tags:
+       - flowfuse
+       - development
+       - contributing     
 ---
 
 # Contributing to FlowFuse

diff --git a/docs/contribute/local/README.md b/docs/contribute/local/README.md
@@ -1,5 +1,13 @@
 ---
 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.
+   tags:
+      - installation
+      - flowfuse
+      - local deployment
+      - mosquitto
+      - docker
 ---
 
 # Local Install

diff --git a/docs/contribute/local/stacks.md b/docs/contribute/local/stacks.md
@@ -1,5 +1,12 @@
 ---
 navTitle: Local Stacks
+meta:
+   description: Configure Node-RED instances with custom memory limits and versions using Stacks in FlowFuse for local deployments.
+   tags:
+      - flowfuse
+      - nodered
+      - local development
+      - stack management
 ---
 
 # Local Stacks

diff --git a/docs/debugging/README.md b/docs/debugging/README.md
@@ -2,7 +2,12 @@
 navGroup: Support
 navTitle: Debugging Node-RED issues
 meta:
-   description: Learn how to troubleshoot unresponsive Node-RED instances using Safe Mode.
+  description: Learn how to troubleshoot unresponsive Node-RED instances using Safe Mode.
+  tags:
+    - debugging
+    - flowfuse
+    - nodered
+    - safe mode
 ---
 
 # Node-RED Safe Mode
@@ -19,4 +24,4 @@ starting the flows. You can log in to the editor, make any necessary changes
 and then deploy to restart the flows.
 
 Once recovered you should delete the `NODE_RED_ENABLE_SAFE_MODE` environment variable
-to prevent it entering Safe Mode the next time it is restarted.
+to prevent it entering Safe Mode the next time it is restarted.
diff --git a/docs/device-agent/deploy.md b/docs/device-agent/deploy.md
@@ -2,7 +2,12 @@
 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.
+  description: Learn how to deploy Node-RED flows to devices using FlowFuse, enabling seamless development and deployment processes.
+  tags:
+    - deployment
+    - nodered
+    - flowfuse
+    - device management
 ---
 
 # 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
@@ -3,6 +3,10 @@ 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.
+   tags:
+      - installation 
+      - device agent
+      - flowfuse
 ---
 
 # Installing Device Agent

diff --git a/docs/device-agent/introduction.md b/docs/device-agent/introduction.md
@@ -3,6 +3,11 @@ 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.
+   tags:
+      - flowfuse
+      - nodered
+      - remote device management
+      - device agent
 ---
 
 # FlowFuse Device Agent

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

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

diff --git a/docs/device-agent/register.md b/docs/device-agent/register.md
@@ -3,6 +3,10 @@ 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.
+   tags:
+      - device registration
+      - flowfuse
+      - troubleshooting
 ---
 
 # Register your Device

diff --git a/docs/device-agent/running.md b/docs/device-agent/running.md
@@ -3,6 +3,12 @@ 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.
+   tags:
+      - device agent
+      - flowfuse
+      - configuration
+      - http proxy
+      - offline caching
 ---
 
 # Running the Device Agent

diff --git a/docs/hardware/ctrlx-device-agent.md b/docs/hardware/ctrlx-device-agent.md
@@ -3,6 +3,12 @@ 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.
+   tags:
+      - ctrlx
+      - device agent
+      - flowfuse
+      - installation
+      - configuration
 ---
 # ctrlX Device Agent App
 

diff --git a/docs/hardware/ctrlx-node-red.md b/docs/hardware/ctrlx-node-red.md
@@ -3,6 +3,12 @@ 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.
+   tags:
+      - ctrlx
+      - nodered
+      - flowfuse
+      - installation
+      - configuration
 ---
 # ctrlX Node-RED App
 

diff --git a/docs/hardware/introduction.md b/docs/hardware/introduction.md
@@ -3,6 +3,12 @@ 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.
+   tags:
+      - flowfuse
+      - device agent
+      - ctrlx
+      - raspberry pi
+      - installation
 ---
 
 # Device Agent - Hardware