-
Notifications
You must be signed in to change notification settings - Fork 9
refactor(installer): Improve installation summary message #495
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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") |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct.
installer/go/pkg/utils/utils.go
Outdated
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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
installer/go/pkg/utils/utils.go
Outdated
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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
installer/go/pkg/utils/utils.go
Outdated
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) |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
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
flowforge.yml
?FlowFuse/helm
to update ConfigMap TemplateFlowFuse/CloudProject
to update values for Staging/ProductionLabels
area:migration
label