- Handbook
- Company
- Company
- Board & Investors
- Communications
- Decision making and project management
- Guides
- Organizational Structure
- Principles
- Remote Work
- Security
- Access Control Policy
- AI Development and Customer Data Policy
- Asset Management Policy
- Business Continuity & Disaster Recovery Policy
- Cryptography Policy
- Data Management Policy
- Hardware Security Policy
- Human Resources Security Policy
- Incident Response Plan
- Information Security Policy and Acceptable Use Policy
- Information Security Roles and Responsibilities
- Operations Security Policy
- Risk Management Policy
- Secure Development Policy
- Third-Party Risk Management Policy
- Strategy
- Values
- Operations
- Engineering & Design Practices
- Design
- Engineering
- Marketing department
- Marketing
- Internal Operations
- People Ops
- Sales department
- Sales
- Commercial Organization
- Customer Success
- Edge Connectivity Sales Process
- Engagements & Pricing
- Forecast Review
- HubSpot
- Legal
- Partnerships
- Processes
- Professional Services
- Sales Compensation Plan
- Sales Deck
- Sales Meetings
- Sales Regions
- Sales Team Operating Principles
- Self Hosted Dashboard v2 Multi User
- Subscription Agreement 1.5
Editing the Handbook
There are two ways to contribute changes to the handbook: Nuxt Studio (recommended for everyone) and Git (for engineers and technical contributors).
Nuxt Studio (recommended)
Nuxt Studio is a browser-based CMS. You do not need to install anything or know Git to use it.
- Navigate to any handbook page.
- Click "Edit this page" in the right sidebar.
- Sign in with your GitHub account.
- Make your changes in the editor — Studio shows a live preview as you type.
- When ready, click Save / Submit for review. Studio will open a pull-request on GitHub on your behalf.
- Ask a colleague to review the pull-request. Once approved and merged, your changes go live.
Changes to the handbook always go through a pull-request review, whether submitted via Studio or Git. This ensures at least two people agree before anything is published.
Git (for engineers)
If you are comfortable with Git and the command line, you can contribute directly to the website repository.
New contributions
- Check out the latest
mainbranch. - Create a new branch with a descriptive
kebab-casename. - Edit files under
src/handbook/(the source of truth for handbook content). - Commit your changes and push the branch.
- Open a Pull Request on GitHub and assign a reviewer.
- Once approved, the reviewer merges the PR.
Adding to an existing pull-request
- Check out the branch associated with the open PR.
- Make your changes, commit, and push — the PR updates automatically.
- Coordinate with the PR owner on who will review and merge.
Reviewing a pull-request
- Check out the branch on your machine.
- Review the changes; leave comments or suggestions on GitHub.
- Approve and merge once you are satisfied.
Glossary
Branch
A complete copy of the project you can edit without affecting the live site. Changes stay on your branch until merged.
Commit
Saving a set of changes to a branch.
Git
A version-control system used to track changes to files collaboratively. Our developers use it for code; Nuxt Studio uses it behind the scenes for handbook edits.
GitHub
The website that hosts our Git repositories and where pull-request reviews happen.
Handbook
FlowFuse's public document explaining how we run the company.
Live
The current published version of the handbook, accessible at /handbook/.
Markdown
The text format used for handbook pages. It lets you add headings, links, images, and lists using plain text characters. See the Markdown guide.
Pull-Request
A request to merge changes from a branch into main. It is the point where a colleague reviews and approves your work before it goes live.
Reviewer
A team member who checks your work and provides feedback before it is published.