Define maintenance periods #28
Description
Due to our current deployment practices, the production API may need to be "offline" while we do maintenance or deploy new versions. There are several considerations we will need to determine:
- Do we define a regular maintenance window so EHRs know and expect outages ahead of time? If so, when is that maintenance window that inflicts least harm to end-users but is sensible for city staff to maintain?
- From what email address do we want to send updates to subscribers for upcoming maintenance and other forms of communication? My initial inclination is from DoIT's "developers" email address.
- Should we post alerts to any other page, such as the Lead Safe API documentation or the Dev blog? My inclination is to do the latter.
- When we anticipate changes to the API (particularly API-breaking changes), where do we post the updates and how much of a lead-time do we provide? As for location, I'd recommend the Dev blog. As for lead-time, we should speak with the end-user to determine what is appropriate or needed.