Resources and documentation links¶
A resource is a reusable pointer to help material. Create one with New content, then Documentation link. Steps, tips, launchers and resource centres reference resources instead of embedding URLs, so a URL change is made once.
Fields¶
| Field | Notes |
|---|---|
| Type | document, link, video, faq, contact |
| Address | An https: URL |
| Open in | New tab or same tab in the studio. The schema also defines panel and modal |
| Summary | Short description shown in lists |
From a step you can attach documentation links directly (the New link shortcut creates the resource and attaches it).
How links open¶
Links open with noopener. When a resource opens in an embedded viewer it uses a sandboxed iframe (see the security rules in packages and rules).
Worked example¶
- New content, Documentation link: "Policy number format". Type
document, addresshttps://intranet.example.com/policy-numbers, open in new tab. - Open the intake walkthrough, step 2, and attach the link under documentation links.
- Publish both. The step shows the link; changing the URL later means editing one resource.
Gotchas¶
- Only
https:addresses are accepted by the form. panelandmodalopen-in modes exist in the schema but the studio form offers only new tab and same tab.- Many internal sites send
X-Frame-Optionsor a CSPframe-ancestorsheader, so an embedded viewer may show nothing. Use new tab for those. - Exports bundle the resource, not the document it points at. If the target is private, readers need access to it on their own.