Skip to content

Rename "Add to Instance" menu action and improve documentation for device-to-instance assignment #6531

@dimitrieh

Description

@dimitrieh

Problem

Image

The current "Add to Instance" menu action (shown in the Remote Instances kebab menu) is confusing because it doesn't communicate what's actually happening:

• It's not "adding" or "nesting" one instance inside another
• It's establishing a parent-child deployment relationship where the hosted instance becomes the source of truth and the remote instance/device receives snapshots pushed from it

Current constraints (undocumented)

Per internal knowledge from the team:

• Remote instances can only be assigned to hosted instances
• Remote instances cannot be assigned to other remote instances
• Hosted instances cannot be assigned to remote instances
• Hosted instances cannot be assigned to other hosted instances

This is considered a legacy feature that predates DevOps Pipelines.

Documentation gaps

Current docs (/docs/device-agent/register/) mention "Assign to hosted instance" but:

• The directionality constraints above are not documented
• The "Add to Instance" menu item isn't explained in context
• No guidance on when to use this vs. DevOps Pipelines
• The parent-child snapshot deployment relationship isn't clearly articulated

Proposed changes

1. UI rename — Change "Add to Instance" to something clearer (suggestions welcome):
• "Assign to Hosted Instance"
• "Link to Hosted Instance"
• "Set Deployment Source"

2. Documentation update — Add explicit documentation covering:
• What assignment means (snapshot deployment relationship)
• The constraints (what can/cannot be assigned to what)
• When to use this vs. DevOps Pipelines

References

• Concepts page: https://flowfuse.com/docs/user/concepts/
• Device registration: https://flowfuse.com/docs/device-agent/register/
• Deploying flows: https://flowfuse.com/docs/device-agent/deploy/

Metadata

Metadata

Labels

area:docsImprovements or additions to documentationarea:frontendFor any issues that require work in the frontend/UIarea:remote-instanceWork related to remote instancestype:featureNew feature or request that needs to be turned into Epic/Story details

Type

No type

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions