Documentation panel

The book icon in the header opens the platform's documentation in a panel on the right. The page you were working on stays visible beside it — it narrows rather than being covered — and the panel stays open while you move around the portal. Drag the panel's left edge to make it wider or narrower; the portal remembers the width for you in this browser. On a narrow screen, such as a phone, the panel fills the screen. Esc closes it.

The panel shows the documentation of everything installed on your platform, in the portal's language: browse the contents, or search for a topic from the header search — documentation results appear under Documentation. A page that describes something you lack the permission for in the current boundary says so ("Requires … — you don't have it here"); you can still read it.

Open in own window moves the documentation to a separate browser window; while that window is open, documentation you open from the portal — a search result, for example — opens there. Platforms older than the documentation service show Documentation not available instead.

Error messages lead here too. When the portal shows an error that the documentation explains — in a notification or on the page — it has a Read more button that opens the panel at the explanation. From inside a dialog, or while one is open, it opens the documentation in its own window instead, since the panel would be hidden behind the dialog.

The panel

Part	What it does
Book icon, in the header	Opens the panel, or closes it when it is open
Users and Administrators	Switch between the guides for people using the platform and the documentation for platform operators. Shown only to platform administrators (lifecycle/view at the platform root); everyone else sees the user guides.
Open in own window	See A window of its own
Close	Closes the panel. Esc does the same while you are in the panel, except in a filter field that has text: there it clears the filter first.
Left edge	Drag it to resize the panel, or select it and use the Left and Right arrow keys; Home and End make the panel as narrow or as wide as it goes. The panel is at least 320 pixels wide and takes at most 60 % of the window, up to 960 pixels.

Reading a page

• The panel opens on the contents: a section per installed module, with its icon, its name and how many pages it has. Choosing a page replaces the contents; the path above the page title — starting with All documentation — leads back.
• By module and By type, above the contents, switch between that view and one grouped by the kind of page: Tutorials to learn by doing, How-to guides for a task, Reference to look something up and Explanation for how things work. The choice stays while you read a page and come back.
• Select a module's or a kind's heading to fold its pages away, and again to show them. Everything starts unfolded; the portal remembers what you folded in this browser.
• Filter pages, at the top of the contents, narrows them as you type: to pages whose title, module or description contains what you typed, whatever the case or accents ("atkomst" finds "Åtkomst"). The matching part of each title is highlighted, modules with a match open, and the rest are hidden until you clear the filter. Esc in the field clears it; a second Esc closes the panel. When nothing matches, the contents say No matching pages, with Clear filter below. The filter and the switch stay at the top while the contents scroll.
• Under Reference, each module's hand-written pages come first; the reference generated from the platform itself — API, configuration and IAM reference — follows under API & configuration reference.
• Addresses and names in the text are filled in for your installation.
• Machine translated marks a page no person has reviewed yet.
• Requires … — you don't have it here lists the permissions the page's steps need that you do not hold in the boundary selected in the sidebar. It is a note, not a lock.
• A link into a module that is not installed on your platform is shown as text, marked "not installed on this platform".
• Code examples have a Copy code button.

A window of its own

Open in own window closes the panel and opens the documentation as a page of its own, at https://portal.example.com/docs, in a separate browser window or tab, with the contents beside the page. While that window is open, documentation you open elsewhere in the portal — a documentation search result, for example — opens in it instead of in the panel. The book icon still opens the panel.

Did this help?

Every page ends with Did this help? Answer Yes or No; the answer is saved at once, and you can add a short comment. Answering again replaces your earlier answer. Documentation searches you submit with Enter that find nothing at all, no page, resource or documentation, are counted too; results that appear while you type are not. Both stay on this platform and are saved without your name; an administrator can export them and send them to Stackship, so do not write personal information in a comment. See Docs feedback for what is kept.

When the documentation cannot be shown

• On a platform version without the documentation service the panel shows Documentation not available — "Documentation is not available on this platform version."
• If the documentation cannot be loaded, Try again retries.