[SC-17836] Document inventory field variables in Long Text fields - #1480
Open
even-steven wants to merge 1 commit into
Open
[SC-17836] Document inventory field variables in Long Text fields#1480even-steven wants to merge 1 commit into
even-steven wants to merge 1 commit into
Conversation
Covers both surfaces that shipped in frontend#2822 / backend#3492: the variable picker in a Long Text field's template editor (Settings) and in the field's value on an individual record. Documents the behavior as implemented rather than as specified. The story called for one-level resolution and for the edited field to remain in its own picker; what shipped resolves two levels with cycle detection and excludes self, so the guidance follows the code. The Long Text entry in _field-types.qmd is split into inventory- and artifact-scoped variants, following the pattern the Attachments entry already uses in that file. Variables apply only to inventory record fields, so the artifact page and the RevealJS training deck (which renders the include in an artifact context) keep the original text. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
|
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
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.
Pull Request Description
What and why?
Documents sc-17836 — inserting inventory field variables into rich-text Long Text fields, shipped in validmind/frontend#2822 and validmind/backend#3492.
Both surfaces that shipped are covered:
Manage inventory fields → Insert field variables into a Long Text template.Edit inventory fields → Insert field variables into a Long Text field.Two new includes carry the shared content so the two pages can't drift:
_insert-field-variables.qmd— the picker steps and what the drop-down contains._field-variable-resolution.qmd— when values resolve, theAccess denied/Circular reference/Exceeded max depthmarkers, and attestation-snapshot behavior.The
Long Textentry in_field-types.qmdis split into inventory- and artifact-scoped variants, following the pattern theAttachmentsentry already uses in that file. Variables apply only to inventory record fields, so the artifact page keeps the original one-line text.Documented as implemented, not as specified. Two places where the shipped behavior differs from the story's acceptance criteria, and the docs follow the code:
Exceeded max depthmarker (RECORD_FIELD_MAX_DEPTH = 2)excludeFieldKey), per backend3221ecdd/ frontend4ae0595aBehavior documented that isn't in the story at all: field-level read permissions produce an
Access deniedmarker rather than a blank (the value never reaches the browser); inventory CSV exports contain resolved values; a template assigned to several record types can only offer variables shared by all of them.How to test
Rendered locally against
--profile development. All four consumers of the edited include render clean, with only the pre-existingUnable to resolve link target: validmind/validmind.qmdwarning that any isolated single-page render produces.Pages to review, on the deployed preview:
Long Textfield-type entryLong Textmust still read as the original one-liner, with no variables guidanceLong Textunchanged in both the inventory and artifact tabsI checked the deployed preview, not just the local render: the new section is present on the inventory page, and the variables wording appears zero times on both the artifact page and the training deck, so neither regression fired.
Verified in the rendered HTML: the
Long Textdefinition list still emits proper<dt>/<dd>despite the new fenced divs, and step numbering continues across the include boundary (<ol start="3">) on both pages.What needs special review?
1. The feature is behind a LaunchDarkly flag that currently defaults to off.
launchdarkly.rollout.inventory-field-variables(OfflineFlagsdefaultfalse). This PR documents it as generally available. Please confirm the flag will be on for 26.09 before merging, or tell me how the docs team prefers to stage docs ahead of a rollout — I did not invent a convention for it.2. The RevealJS training deck is deliberately not updated.
_field-types.qmdis included twice intraining/administrator-fundamentals/customizing-your-inventory.qmd— once for inventory fields, once for artifact fields — and the RevealJS block is gated only on format, with noincludes.inventorymeta to switch on. Adding inventory-only guidance there would be wrong in the artifact tab. Training coverage for this feature therefore needs its own decision; happy to follow up.3. Terminology check on the picker labels. The drop-down is documented as Record → Core Fields /
{Group}/ No Group / Stakeholders. Those come from the backend registry, relabeled fromModel FieldstoRecordin the frontend, and match the existing wording in_reference-field-values.qmd. Worth a glance from someone who has the flag on.4. No screenshots. I did not have the flag enabled against a live environment to capture the picker. Say the word if you want them and I'll add them.
Dependencies, breaking changes, and deployment notes
Release notes
You can now reference other inventory field values from inside a rich-text Long Text field — both when defining the field's template and when editing the value on an individual record. Insert a field as a variable and it resolves to that record's current value, so a summary stays in sync as the record changes. Learn more ...
Checklist
documentation