Updating the Installer Field Support Guide

This document defines how updates to the On-site Installation Support materials are submitted and published.

When to Update

Update the guide when any of the following occur:

• A new device category is introduced
• An installation or dashboard workflow changes and needs external-facing documentation
• A recurring installer or support issue is traced to missing or unclear documentation
• An installer reports that instructions are confusing, incomplete, or inaccurate

Submission Process

All updates must be submitted through GitLab. Ad hoc channels like Slack are not valid submission methods.

Use a Merge Request when the change is clear and ready to implement. Use a GitLab Issue when the change needs discussion before implementation.

Each submission must include:

• Section of the guide affected (file path or section name)
• Description of the issue or gap
• Proposed changes
• A priority:: scoped label (priority::critical, priority::high, priority::normal, or priority::low)

Review and Approval

All Merge Requests require:

1. Automated checks to pass (formatting, build, documentation standards)
2. At least one reviewer approval confirming accuracy and clarity

Priority level determines how quickly a Merge Request should be reviewed and merged. Critical and High priority changes should not wait for a scheduled review cycle.

Priority Levels

Priority levels indicate how urgently a documentation gap needs to be addressed. Apply a priority:: scoped label to every Issue and Merge Request. The assigned Customer Support Engineer is responsible for opening the submission and driving it to completion within the target timeframe.