[WIP] Add docs for the assign/unassign entity group to edge rule nodes - #629
Open
AndriiLandiak wants to merge 2 commits into
Open
[WIP] Add docs for the assign/unassign entity group to edge rule nodes#629AndriiLandiak wants to merge 2 commits into
AndriiLandiak wants to merge 2 commits into
Conversation
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
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
Documents the two new PE rule nodes added in thingsboard/thingsboard-pe#5030: assign entity group to edge and unassign entity group from edge.
Both nodes ship with a
docUrlpointing at these pages, so until this lands the in-form help button 404s for both.In PE an entity group is the only route by which devices, assets, entity views, dashboards and users reach an edge, so these nodes are what let a rule chain automate edge onboarding instead of doing it by hand.
Each page follows the
add-to-grouplayout — configuration, message processing algorithm, output connections, worked examples with real config JSON, and a JSON schema — plus a## Usagesection (therest-call-replyprecedent) covering how to actually wire the node into a chain:Edge name patternmode, and why only one of them needs ascriptnodecheck fields presence, and why an unresolved pattern is aFailurerather than a silent skipentity type switchType of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)public/redirects.jsonregenerated — see note below)releaseskill)Affected products
The nodes are PE features, so PE and PaaS (including the EU variant) are the pages that matter. Stubs are added for all six product variants — CE, PE, PaaS, PaaS EU, Edge, Edge PE — because every other action node has all six, and the shared include carries the "requires ThingsBoard PE or ThingsBoard Cloud" note rather than the stub set being trimmed.
Related issues
Platform side: thingsboard/thingsboard-pe#5030. No tracking issue.
Note on redirects
src/data/redirects.tsis unchanged — nothing was renamed or removed.public/redirects.jsonis regenerated because the generator enumerates every page under theuser-guide/rule-engine-2-0/nodes/*→reference/rule-engine/nodes/*prefix rename, so two new pages add ten entries (four product prefixes, plus thepe/edge→edge/perename).Worth knowing for the platform PR: both nodes'
docUrlvalues use the legacyuser-guide/rule-engine-2-0/...shape, matching the shippedadd-to-groupandremove-from-groupnodes. That resolves through the splat rule inpublic/_redirects, so no annotation change is needed on the platform side.Checklist
pnpm checkpasses — 0 errors, 0 warnings across 646 filespnpm lint:eslintpassespnpm lint:slugcheckpassespnpm lint:linkcheckpasses locally — run against a fullpnpm build:fast(4535 pages), no link issuespnpm generate:redirects