docs: trim the Device Agent install overview - #8240
Open
dimitrieh wants to merge 1 commit into
Open
Conversation
Three things on this page were redundant or out of date. The bullet list under the quick install block repeated the two links directly above it. It now lists only the alternative paths. The Node.js prerequisite read as though the reader must install Node.js, on a page whose recommended path installs it for them. It now says which paths actually need it. Verify the installation told the reader to run the agent so it could help them register, which the installer has already done by that point. It now checks the service, using the real service name: the installer suffixes it with the port, so the default is flowfuse-device-agent-1880, not flowfuse-device-agent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Three corrections to
docs/device-agent/install/overview.md. The install commands on this page were already right and are untouched.The bullet list repeated the block above it. The page shows the quick install commands, links the Quick Start and the Installer reference, then immediately repeated both of those links as bullets. It now lists only the three alternative paths.
The Node.js prerequisite was misleading. It read as though the reader must install Node.js 18+, on a page whose recommended path installs a runtime for them. It now says which paths actually need it.
"Verify the installation" step 2 was stale. It told the reader to run the agent so it could help them get registered, which the installer has already done by that point. It now checks the service instead, and moves the register-it-yourself pointer to where it applies.
That last change also fixes a wrong service name. The installer suffixes the service with the port (
installer/go/cmd/install.go:54), so the default isflowfuse-device-agent-1880, notflowfuse-device-agent.Related Issue(s)
None.
Checklist
Docs-only change, so no performance impact and no tests apply.