Documentation pages

A page is free-form documentation: how the network is laid out, the steps for a new starter, who to call when the internet goes down. Pages belong to one customer, or are internal (your own team's).

Write a page

1. Open Documentation (inside a customer's workspace for that customer's pages).
2. Choose New page, give it a title and, optionally, a folder.
3. Write in Markdown: ## headings, - lists, tables with |, code. Switch to Preview to check it, then Save.

Pages show their text as you wrote it. Raw HTML isn't rendered, and images aren't loaded from other sites: a page shows an image's alt text instead.

Folders

Folders keep a customer's pages in order. Choose New folder under the folder list (inside the selected folder, if one is selected). A folder can be renamed, or deleted once it's empty. Move a page with ⋯ → Move to a folder.

Versions

Every save that changes the title or text keeps a new version. Versions lists them with who saved each and when; open one to read it and Restore it, which saves it again as the newest version (nothing is lost).

If someone else saved the page while you were editing it, your save is refused rather than overwriting their change: copy your text, reload and apply it again.

Files

Attach PDFs, images, Office documents, text, CSV and ZIP files of up to 10 MB with Attach. Files are stored encrypted and always download (the browser never opens them in place). SVG and HTML files can't be attached.

Links

A customer's page can be linked to that customer's devices, contacts and sites under Linked to → Link. The device's Documentation tab then lists the page.

The customer portal

⋯ → Show in the customer portal shares a customer's page with that customer's portal users, who can read it and download its files. Internal pages can't be shared. Portal users never see who wrote a page.