This is an old revision of the document!
How this wiki is organized
This page is about how the Suntex Knowledge Base is put together. For markup, use the syntax page. To try something without changing a real page, use the playground.
Departments
Each department is a folder. Its start page is the landing page, and the label in the menu is that page's first heading.
| Menu | What belongs there |
|---|---|
| Field Service | Route procedures and technician training |
| Customer Service | Adding customers, repairs, and remodels |
| Office Operations | Billing, payroll, and sales tax |
| Human Resources | Handbooks, hiring, and benefits |
| Marketing | Brand, campaigns, and customer-facing content |
| Technology | Networks, servers, phones, and system configuration |
The top menu is maintained by hand. Everything under a department is picked up automatically.
Where a new page goes
- One article is a page in the department folder. Routing lives at
field_service:routing. - Several related articles get their own folder, with a start page whose first heading is the folder's name.
- A course goes in
department:training:course_name, with one page per chapter. Cleaner Training is field_service:training:pool_technician.
Payroll processing stays in Office Operations. Human Resources is for people policy, not the daily payroll run.
Names
The address of a page is its folder path, in lowercase words separated by underscores: customer_service:new_customer. The name people see in the sidebar, the menu, and the “you are here” line is the first heading on the page, not the file name. field_service:routing shows up as “Managing Cleaner Routes” because that is the heading.
When you add a page, write that heading first, as a level-1 heading:
====== Opening the pool ======
The sidebar lists folders first, then pages by that heading. A page named sidebar or navbar is hidden and, inside a department, replaces the automatic menu. Do not create or edit those pages to add links. New pages appear in the sidebar on their own.
Moving or renaming a page changes its address. Old links stop working. Ask a wiki admin before renaming a page that people already use.
Editing
Signed-in staff can edit. Open a page and use the pencil, or follow a red link to create a page that does not exist yet. You can also go straight to a new address, such as field_service:opening_the_pool, and create it there.
The same page accepts normal DokuWiki markup and Markdown. The syntax page lists the DokuWiki tags. A few that already show up in our pages:
<lead> A short summary under the title. </lead> <callout type="success" title="What done looks like"> One or two sentences on how you know the task worked. </callout>
Pictures belong with the page that uses them. Upload the file, then insert it by its file name. on a Cleaner Training chapter looks in that chapter's folder. Write a caption after a 
|:
{{pad-diagram.png?700|Spa-combo equipment pad.}}
Every save keeps an older copy. Use “Old revisions” on the page to put a previous copy back.
Leave passwords out
Anyone who can sign in can read the wiki. Do not put passwords, keys, or other shared secrets on a page.If you get stuck
- Syntax shows the markup.
- Playground is a scratch page. It is wiped and rewritten often, so do not store real procedures there.
- About DokuWiki points at the manual for the software under this site.
- The home page links to each department.