Link pages to work, code and operations

Folio pages link both ways to the other products. This page shows how to connect a page to Orbit work, Forge code and Pulse operations. Folio stores keys and references only; what a reader sees is always decided by the other product with that reader’s own permissions.

Work items (Orbit)

• Live work item keys. Type a key such as PROJ-12. It becomes a link that shows the item’s current status and title, as far as the reader may see it.
• Embedded work lists. Insert a list of work items by filter: project, status, type, assignee, label or sprint. It refreshes when the page opens and shows only items the reader may see.
• Create a work item from selected text. Select text in a page and choose Create issue (for people who can write in the space). The dialog proposes the space’s project, a title from the selection and a description with the quote and a link back to the page. After it is created, the key is inserted into the page right after the quote. If that is not possible (for example the quote is inside code or the page cannot be edited), the key goes into an inline comment on the quote.
• Related pages in the work item. An Orbit work item has a lazily loaded Related pages block that lists the pages where it is mentioned.
• Sprint review pages. The sprint review template asks for a sprint of the space’s project and fills the page: a properties block (sprint, status, dates), the goal in a callout, a summary of done and not done work, the work item keys as live links, a table of scope changes and retrospective sections.

Code and delivery (Forge)

• Code in a page. A forge-file block shows a file or a line range from a Forge repository. By default it pins a commit; the page tells you when the file has changed on the main branch and offers Show latest. If the reader has no access to the repository, the block says so.
• Status chips. Links to Forge merge requests and pipelines are drawn as chips with live status.
• Release notes from a deployment. The release notes template asks for a repository and a successful deployment (or a successful pipeline). It fills the page with properties, a “What shipped” callout, Highlights, the Orbit work items mentioned in the commit titles or linked to the commits, a table of commits linking into Forge, and Known issues. Choose Start without Forge for an empty template.
• Docs as code. A Markdown folder of a repository can be synced into a space; see the Folio section.

Operations (Pulse)

• Runbooks with live state. When a Pulse monitor’s runbook URL points to a Folio page, that page shows a panel, Runbook for N Pulse monitors, above its text. It lists each monitor’s state (Alert, Warn, No data, OK or Disabled), how many groups are in the worst state, whether it is muted, and a link into Pulse. The panel refreshes every minute while the page is open. A reader without access to Pulse does not see the panel. Links to monitors in the text are drawn as chips with live state.
• Postmortems from incidents. The postmortem template first asks which Pulse incident to use. The page is filled with properties (incident link, severity and status, commander, declared, resolved, duration, services), a blameless review block, the summary and impact, a timeline table in UTC built from the incident timeline (alerts, deployments, notes and status changes, up to 200 rows), signals in Pulse as live chips, and sections for root cause, what went well and what went wrong. Write in Folio from a Pulse incident opens this directly. After you publish, Folio records the page as the incident’s postmortem, unless the incident already has one.
• Follow-up actions as Orbit tasks. A page with a “Follow-up actions”, “Follow-ups” or “Action items” section shows a panel with how many of its Orbit tasks are done and how many open items are not tasks yet. Create N Orbit tasks (up to 25 at a time) creates the work items, each linking back to the page, and publishes the keys into the list. For a postmortem, each new task is also linked to the Pulse incident.
• Pulse charts. A pulse-chart block draws a service metric for a chosen period, with a data table and an “Open in Pulse” link.

Permissions

Because the reader’s own session reads the other product, a linked item or chart that the reader cannot see is shown as “no access” instead of leaking data.

Related

• Editor and Markdown reference
• Monitors and alerts (runbook URL)
• Merge requests and approvals