This intranet is the group’s working handbook. If you notice a missing page, an outdated instruction, or a repeated question that keeps coming up in chat, update the site instead of leaving the answer buried in messages.
If you are not sure who owns a page or you do not have edit access, contact the News Officer.
What belongs here
Good pages for this intranet usually answer one practical question clearly:
- how to complete a group or NUS process
- how to set up a tool, account, or workflow
- where to find a shared resource
- what the current group expectation or policy is
Avoid using the intranet for:
- private notes
- rough meeting minutes without context
- duplicate copies of an existing page
- PDF-only documentation without a short Markdown summary
Where to put new content
Put pages in the section that best matches the user’s task:
- Group for onboarding, contacts, rules, facilities, and shared resources
- NUS for university administration and compliance
- Research for writing, figures, and research practice
- Simulation for software-specific and HPC workflows
- Techniques for coding, Linux, Python, containers, websites, Git, and AI tools
If a topic needs several related pages, create a folder and use index.md as the landing page.
How to add or update a page
Small edits
For spelling fixes, broken links, or outdated steps:
- Edit the existing page.
- Keep the current URL if possible.
- Update the instructions instead of creating a second page.
New pages
If the topic is new, create a page with at least this frontmatter:
---
title: Page Title
---For procedural pages, adding tags and an author is helpful:
---
title: Page Title
tags:
- topic
authors: name
---If you are working locally, you can create a new folder page with:
npm run quartz new --content "path/to/folder"Writing style
- Put the quick answer near the top.
- Write for the task, not for the org chart.
- Use page titles that match what people will search for.
- Keep steps concrete and specific.
- Mention common mistakes if they are likely to waste time.
- Link to the next relevant page instead of repeating the same explanation.
Before you finish
Check these before considering the edit done:
- The page has a clear title.
- The page is linked from a section landing page or another page a human would actually browse.
- Internal links still work.
- The instructions match current lab practice.
- A reader can quickly tell who to ask if the page becomes outdated.
Good maintenance habits
- Improve the page that answers a repeated question.
- Prefer updating the current source of truth over adding a parallel document.
- Add short Markdown context for supporting PDFs.
- If a page becomes stale, fix it as soon as you notice rather than waiting for a bigger cleanup.