Your first space and page
In this tutorial you create the knowledge space of an Orbit project, write and publish a first page, arrange it in the page tree and find it again with Ctrl+K.
Folio is the knowledge base inside Orbit projects. A space belongs to one project and has a page tree. Who can read or edit it is decided by the roles people already have in the project: administrators, members and viewers. People who are deactivated lose access at once.
1. Open Knowledge and create the space
Section titled “1. Open Knowledge and create the space”-
Open your Orbit project and choose Knowledge in the project navigation.
-
If the project has no space yet, create it with the button. A space has a key, a name, a description and a home page. Its permissions come from the project’s roles.
-
Open the space. The page tree is on the left, and the home page is the first page.
Spaces can be archived by administrators. An archived space is read-only.
2. Create a page from a template
Section titled “2. Create a page from a template”-
Choose New page. The dialog lists the built-in templates next to any templates your space has defined:
- meeting notes
- decision (ADR)
- requirements
- how-to
- runbook
- postmortem
- retrospective
- release notes
Pick one, or start from an empty page.
-
Give the page a title. A page created under another page becomes its child.
Some templates ask a question first: the postmortem template asks for a Pulse incident, the release notes template for a Forge deployment or pipeline, and the sprint review template for a sprint. You can always start without it.
3. Write in Markdown
Section titled “3. Write in Markdown”The editor shows a live preview next to the Markdown source, with a formatting toolbar, keyboard shortcuts and slash commands. Type / to insert a heading, a table, a code block, a callout, a task list, a link to a page, a link to a work item, a status label, a date, or an image or file.
A few things that are useful from the start:
[[Page title]]links to another page. A link to a page that does not exist yet is kept as a pending link and resolves when the page is created.- A work item key such as
PROJ-12in the text becomes a live link with the item’s current status and title. - Task lists can be ticked while reading the page.
The complete list of blocks is in the Editor and Markdown reference.
Drafts are saved for you
Section titled “Drafts are saved for you”Your edits are autosaved as a draft, separate from the published page. Readers keep seeing the published version until you publish. A draft is kept per author.
4. Publish
Section titled “4. Publish”Publishing creates a new immutable version with your name, the time and an optional note. If someone else published while you were editing, you do not overwrite them: Folio shows a conflict with both versions so that you can decide.
If another person has the page open for editing, you see their avatar and a warning (“Anna is editing”) before you start; you can still choose Edit anyway.
5. Organise the tree
Section titled “5. Organise the tree”Drag pages in the tree to move them, or move them with the keyboard. Folio prevents cycles and keeps the order stable even when two people move pages at once. Breadcrumbs show where a page sits.
Deleting a page moves its whole subtree to the trash. Restoring puts it back where it was. Only space administrators can delete permanently.
6. Share and find
Section titled “6. Share and find”- Every page has a permalink of the form
/folio/p/<id>, which survives moves and renames. - Press Ctrl+K to open quick search: recent pages first, and title search from the first character, with keyboard navigation.
- The search page looks through the title and text of pages, filtered by space, label, author and date, and also shows matching Orbit work items and Forge repositories.
Pages render safely: Markdown is rendered without executing HTML or scripts.