Write down how things are set up once: firewall and switch notes, how the offices connect, the steps for a new hire. Pages nest, so a page with pages under it works as a folder.

Overview

Documentation shows every page as a tree. A page sits at the top level or under another page, and the pages under it are listed at the bottom of its page as Pages in followed by its name. There is no separate folder type: any page can hold others.

Each page shows when it was last updated and by whom, a link to its History, and an Archived badge if it is archived. Every save is kept (see History and restore).

With clients turned on, each client has its own documentation. Pages belong to the client you are working in, and a page you put under another page belongs to that page's client.

Requirements

• Role: Read documentation to read pages (every built in role by default). Write, archive and restore documentation to write, move and archive them (Admin, Manager and Technician by default).

Steps

Write a page

1. In the sidebar, open Documentation, then Documentation.
2. Click New page.
3. Optionally pick a starting point under Start from: Firewall, Switch, Site or office, Server or Procedure. Each fills the page with headings to complete. Leave it on A blank page to start empty.
4. Enter a Title.
5. Under Under, pick the page this one belongs to, or leave Top level.
6. Optionally set Order. Lower numbers come first among pages at the same level.
7. Write the page in Markdown (see Markdown and diagrams).
8. Click Save.

Add a page inside another page

1. Open the page that should hold the new one.
2. Click New page here. Under is already filled in.
3. Write the page and click Save.

Edit or move a page

1. Open the page and click Edit.
2. Change the text, or pick a different page under Under to move it. A page and everything under it move together.
3. Click Save.

Archive a page

1. Open the page and click Archive.
2. Confirm with Archive.

The page leaves the library and search. Its history is kept. To find it again, tick Show archived pages at the bottom of Documentation; archived pages show struck through. Open it and click Unarchive to put it back.

Notes

Note: Templates are only a starting point. Nothing about a page remembers which template it came from, so edit the headings freely.

Note: With clients turned on and All clients chosen in the switcher, New page is hidden. Pick a client in the switcher first. See The client switcher.

Troubleshooting

"A page cannot sit under itself or one of its own pages." You picked the page itself, or a page inside it, under Under. Pick a page outside it, or Top level.

"Pick a client in the switcher first" You opened New page while working in All clients. Choose a client under Working in and try again.

I cannot see New page or Edit. Your role does not include Write, archive and restore documentation. Ask an Admin.

FAQ

Can I delete a page? No. Archive it instead. Archived pages keep their history and can be put back.

Does moving a page create a new version? No. A version is kept when the title or text changes. Moving a page or changing its order does not add one.