FlowFuse / FlowFuse/flowfuse

Improve dialogue for registering remote instance

Open
#5,861 4 comments 0 reactions 0 assignees View on GitHub
size:S story
Dominant language
JavaScript
Stars
400
Forks
89
Avg merge
1d 20h
Merged PRs (30d)
149

Description

### Epic

_No response_

### Description

**As a user connecting a remote device**

**I want to have clearer instructions at the beginning of the process**

**So that I understand what I am about to do and can be successful in installing the device agent**

We lose about 50% of users from the step from a click to install a remote instance to registering a device:

Image

A reasonable hypothesis is that users who are clicking the button to create a remote instance don't really understand what they're doing. Revise the initial dialogue that appears in the installation process.

Here is the current dialogue:

Image

Make use of the right pane that opens up, like with the new Tables interface. It looks clean and modern and provides much more space to present the user with useful information and provide the needed steps to connect a device:

Image

### Page copy and functionality

**Note**: Use the same structure as the Create New Table right-nav area.

Title: "Step 1: Add Remote Instance"

**Add body text**: Using an edge device with FlowFuse requires two steps.

First, you'll create the Remote Instance here. Second, you'll install the Device Agent on your edge device.

**Larger heading**: Create a Remote Instance

**Note**: Include fields for Name, Type, and Application, as before.

For "Type" copy, change the description to: "Use this field to give your Remote Instance a Type, which will help with organization"

**Next**: After the user creates the remote instance, the Device Agent installer pops up.

**Current view**:

Image

**Change the copy**.

**Heading**: "Step 2: Install the Device Agent"

**Note**: Above the toggle for One-Line Install or Install via NPM, write:

"Now, install the Device Agent on your edge device. Choose any of the options below."

**Note**: Leave the rest of the installer as it is.

### Which customers would this be available to

All tiers

### Acceptance Criteria

- [ ] Dialogue opens in pane to the right
- [ ] Dialogue describes what a remote instance is and how it is used (new)
- [ ] Dialogue contains initial setup steps
- ...

### Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

Contributor guide

Open the contributing guide

Research direction

Start by locating the remote instance registration dialogue and the Device Agent installer, then compare their structure with the Create New Table right-nav area. Verify the two-step copy, Name/Type/Application fields, right-side pane behavior, and unchanged installer options against the acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
design, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.