Skip to content

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request impreves the installation message summary to include valid FlowFuse platform and documentation links.
Additionally, to maintain clean approach, dedicated function has been introduced for this purpose.

Related Issue(s)

Closes #427

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production
  • Link to Changelog Entry PR, or note why one is not needed.

Labels

  • Includes a DB migration? -> add the area:migration label

Copy link
Contributor

@Steve-Mcl Steve-Mcl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with comments - action them if you consider them reasonable, otherwise nothing to see here.


logger.Info("")
logger.Info("For more details on managing the FlowFuse Device Agent, including commands for starting, stopping, and updating the service, visit:")
logger.Info("https://flowfuse.com/docs/device-agent/install/overview")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this page will exist before release?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct.

logger.Info(" 1. Create a device.yml configuration file in the %s directory", workDir)
logger.Info(" 2. Start the Device Agent service")
logger.Info("Refer to the documentation for detailed configuration steps and examples.")
logger.Info("Once configured, you can return to the FlowFuse platform (%s) and start creating Node-RED flows on your device.", url)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth considering separating the URL from the middle of the text to its own line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

logger.Info("Once configured, you can return to the FlowFuse platform (%s) and start creating Node-RED flows on your device.", url)
case "none":
logger.Info("The FlowFuse Device Agent was already configured. The service is running and ready to use.")
logger.Info("You can return to the FlowFuse platform (%s) and start creating Node-RED flows on your device.", url)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth considering separating the URL from the middle of the text to its own line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

switch installMode {
case "otc", "manual":
logger.Info("The FlowFuse Device Agent is now running and will start automatically on system boot.")
logger.Info("You can return to the FlowFuse platform (%s) and start creating Node-RED flows on your device.", url)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth considering separating the URL from the middle of the text to its own line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@ppawlowski ppawlowski merged commit f2f5c42 into main Sep 11, 2025
7 checks passed
@ppawlowski ppawlowski deleted the fix-installer-better-summary branch September 11, 2025 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Installer: improve installation summary

3 participants