Skip to content

Commit b29c425

Browse files
Hasmin-ACHasmin-AC
authored
Merge pull request #4162 from FlowFuse/add-meta-info-to-docs
add meta information to docs
2 parents 87cfe11 + ddd6a35 commit b29c425

35 files changed

+71
-1
lines changed

‎docs/admin/introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Administering FlowFuse
33
navOrder: 1
4+
meta:
5+
descriptions: Learn how to administer FlowFuse with this comprehensive guide. Explore user management, team setup, instance and stack management, and more.
46
---
57
# Administering FlowFuse
68

‎docs/admin/monitoring.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Monitoring
3+
meta:
4+
description: Learn how to monitor statistical information about your FlowFuse platform using the API endpoint.
35
---
46

57
# Platform Monitoring

‎docs/admin/sso/ldap.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: LDAP SSO
3+
meta:
4+
description: Learn how to configure LDAP-based Single Sign-On (SSO) on FlowFuse's self-hosted Enterprise instances.
35
---
46

57
# Configuring LDAP based Single Sign-On

‎docs/admin/sso/saml.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: SAML SSO
3+
meta:
4+
description: Learn how to configure SAML-based Single Sign-On (SSO) on FlowFuse's self-hosted Enterprise instances.
35
---
46

57
# Configuring SAML based Single Sign-On

‎docs/admin/telemetry.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Telemetry
3+
meta:
4+
description: Learn how FlowFuse collects anonymous usage information to improve platform performance without compromising user privacy.
35
---
46

57
# Usage Telemetry

‎docs/admin/user_management.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: User Management
3+
meta:
4+
description: Explore effective user management on FlowFuse, covering registration, user creation, password management, and team ownership.
35
---
46

57
# User management

‎docs/api/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
navGroup: FlowFuse User Manuals
33
navOrder: 2
44
navTitle: FlowFuse API
5+
meta:
6+
description: Explore the FlowFuse Platform API, a RESTful interface that facilitates custom integrations, workflows, and interactions.
57
---
68

79
# FlowFuse Platform API

‎docs/cloud/billing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: FlowFuse Cloud Billing
3+
meta:
4+
description: Learn about billing details for FlowFuse Cloud, including payment methods, team billing, billing cycles, managing instances, handling failed payments, and cancelling subscriptions.
35
---
46

57
# Billing

‎docs/cloud/introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navOrder: 1
33
navTitle: Introduction
4+
meta:
5+
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.
46
---
57

68
# FlowFuse Cloud

‎docs/contribute/workflows/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: State Flows
3+
meta:
4+
description: Explore key workflows in FlowFuse Cloud with detailed sequence diagrams, covering login, user sign-up, password reset, and more.
35
---
46

57
# Workflows

‎docs/contribute/workflows/device-editor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Device Editor
3+
meta:
4+
description: Explore how to enable and use the device editor in FlowFuse Cloud with detailed sequence diagrams and instructions.
35
---
46

57
# Enabling the device editor

‎docs/contribute/workflows/invite-external-user.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Invite External Users
3+
meta:
4+
description: Learn how to invite external users to your team in FlowFuse Cloud. Follow our guide with clear steps and diagrams for seamless collaboration.
35
---
46

57
# Invite External User Flow

‎docs/contribute/workflows/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: User Login Flows
3+
meta:
4+
description: Learn user login flows in FlowFuse Cloud with clear diagrams and explanations.
35
---
46

57
# User Login Flows

‎docs/contribute/workflows/password-reset.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Reset Password Flow
3+
meta:
4+
description: Learn how to reset passwords in FlowFuse Cloud with our step-by-step guide and detailed sequence diagrams.
35
---
46

57
# Reset Password Flow

‎docs/contribute/workflows/project-create.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Project Creation
3+
meta:
4+
description: Discover how to create projects in FlowFuse Cloud with a clear sequence diagram. Learn about billing and non-billing scenarios.
35
---
46

57
# Sequence For Project Creation

‎docs/contribute/workflows/project-states.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Instance states
3+
meta:
4+
description: Learn about Node-RED instance states in FlowFuse Cloud, from starting and running to safe mode and suspension, with a concise state diagram.
35
---
46

57
# States

‎docs/contribute/workflows/signup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: User Sign up Flow
3+
meta:
4+
description: Learn how users sign up for FlowFuse Cloud accounts with a detailed sequence diagram outlining the process from registration to email verification.
35
---
46

57
# User Sign Up Flow

‎docs/contribute/workflows/team-create.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Team creation Flow
3+
meta:
4+
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.
35
---
46

57
# Sequence For Team Creation

‎docs/debugging/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navGroup: Support
33
navTitle: Debugging Node-RED issues
4+
meta:
5+
description: Learn how to troubleshoot unresponsive Node-RED instances using Safe Mode.
46
---
57

68
# Node-RED Safe Mode

‎docs/device-agent/deploy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Deploying your Flows
33
navOrder: 6
4+
meta:
5+
description: Learn how to deploy Node-RED flows to devices using FlowFuse, enabling seamless development and deployment processes.
46
---
57

68
# Deploying Flows to the Device Agent - Team and Enterprise tier only

‎docs/device-agent/install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Installation
33
navOrder: 3
4+
meta:
5+
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.
46
---
57

68
# Installing Device Agent

‎docs/device-agent/introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: FlowFuse Device Agent Introduction
33
navOrder: 1
4+
meta:
5+
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.
46
---
57

68
# FlowFuse Device Agent

‎docs/device-agent/quickstart-web-ui.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Quick Start with Web UI
33
navOrder: 3
4+
meta:
5+
description: Learn how to add devices and develop workflows using FlowFuse web UI on Devices.
46
---
57

68
# Developing Flows on Your Device

‎docs/device-agent/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Quick Start
33
navOrder: 2
4+
meta:
5+
description: Learn how to add and connect devices to FlowFuse, and develop workflows using the web UI.
46
---
57

68
# Developing Flows on Your Device

‎docs/device-agent/register.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Register your Device
33
navOrder: 4
4+
meta:
5+
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.
46
---
57

68
# Register your Device

‎docs/device-agent/running.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Running the Agent
33
navOrder: 5
4+
meta:
5+
description: Explore how to run and configure the FlowFuse Device Agent, covering startup commands, port settings, HTTP proxy setup, and offline module caching.
46
---
57

68
# Running the Device Agent

‎docs/hardware/ctrlx-device-agent.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: ctrlX - Device Agent
33
navOrder: 3
4+
meta:
5+
description: Learn to install and configure the FlowFuse Device Agent on ctrlX devices for seamless integration with FlowFuse, ensuring efficient device management.
46
---
57
# ctrlX Device Agent App
68

‎docs/hardware/ctrlx-node-red.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: ctrlX - Node-RED
33
navOrder: 2
4+
meta:
5+
description: Discover how to install, log in, and create Node-RED flows on ctrlX devices with the Rexroth CtrlX App by FlowFuse.
46
---
57
# ctrlX Node-RED App
68

‎docs/hardware/introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Overview
33
navOrder: 1
4+
meta:
5+
description: Discover hardware-specific installation guides for the FlowFuse Device Agent on supported platforms like Bosch Rexroth's ctrlX and Raspberry Pi.
46
---
57

68
# Device Agent - Hardware

‎docs/hardware/raspbian.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
navTitle: Raspberry Pi with Raspbian
33
navOrder: 3
4+
meta:
5+
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.
46
---
57

68
# Raspberry Pi

‎docs/install/docker/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
navTitle: Docker install
2+
navTitle: Docker install\
3+
meta:
4+
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
35
---
46

57
# Docker Install

‎docs/install/docker/aws-marketplace.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Docker from AWS Market Place
3+
meta:
4+
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.
35
---
46

57
# Installing FlowFuse from AWS Market Place

‎docs/install/docker/digital-ocean.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Docker on Digital Ocean
3+
meta:
4+
description: Deploy FlowFuse on Digital Ocean Droplets with Docker Compose effortlessly. Set up DNS, configure SMTP, and manage Node-RED applications seamlessly.
35
---
46

57
# 1-Click Digital Ocean Droplet Install

‎docs/install/docker/stacks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: Add Project Stacks on Docker
3+
meta:
4+
description: Configure Node-RED containers with Docker Stacks. Customize memory, CPU, and container images like flowfuse/node-red:latest.
35
---
46

57
# Docker Stacks

‎docs/install/file-storage/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
navTitle: FlowFuse File Storage
3+
meta:
4+
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.
35
---
46

57
# FlowFuse File Storage

0 commit comments

Comments
 (0)