Home Engineering Scheduled maintenance

Scheduled maintenance

Last updated on Apr 17, 2023

Follow the below steps while preparing for a planned downtime/scheduled maintenance event.

Communicate. Communicate. Communicate.

Internal Communication

Ensure all the internal teams are aware of the downtime and possible disruption to their workflow. Once you have confirmation from the internal stakeholders, inform the customers and the community.

External Communication

Chatwoot Cloud

Send an email to inform all the Chatwoot cloud customers about the upcoming downtime and ask them to prepare for any impact. Ideally, this email should be sent with at least a week's notice.

Chatwoot Community

Create an issue in the status repo and tag it with the maintenance label. The issue description should follow the format below.

We will have planned maintenance on Sunday, 20th Feb 2022 IST from 1900-2130 Hours. 

<!--
start: 2022-02-20T13:30:00.220Z
end: 2022-02-20T16:00:00.220Z
expectedDown: chatwoot
-->

This snippet will create an incident on the Chatwoot status page. Next, share the incident URL on Chatwoot discord and Social media handles.

An example of a scheduled maintenance event can be seen here.

During the maintenance event, communicate the progress using the GitHub issue created.