diff --git a/packages/docs/src/es/guide/incidents.md b/packages/docs/src/es/guide/incidents.md index 0a4bf7386..670e84d42 100644 --- a/packages/docs/src/es/guide/incidents.md +++ b/packages/docs/src/es/guide/incidents.md @@ -130,7 +130,6 @@ La severidad del incidente. Hay 4 valores disponibles: Los sistemas afectados a los que se refiere el incidente. Los valores que se pueden usar deben definirse en el archivo de configuración (Más información en [Referencia de configuración](../config/README.md#systems)). - #### resolved - Tipo: `boolean` @@ -139,6 +138,23 @@ Los sistemas afectados a los que se refiere el incidente. Los valores que se pue Si este campo se establece como `true`, el incidente se marca como resuelto. + +#### scheduled + +- Tipo: `string` +- Requisito: `opcional` +- Default: `undefined` + +La hora de inicio programada. Esto define la inicial de la ventana de mantenimiento planificada. + +#### duration + +- Tipo: `string` +- Requisito: `opcional` +- Default: `undefined` + +La duración programada en **minutos**. Esto define la duración de la ventana de mantenimiento planificada. + ### Formatos Alternativos de Front Matter Además, puedes definir el front matter como un [JSON](https://es.wikipedia.org/wiki/JSON) o [TOML](https://github.com/toml-lang/toml). @@ -185,6 +201,19 @@ resolved = true Statusfy solo es compatible con la [versión 0.4.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md) de la especificación TOML. ::: + +## Mantenimiento Programado + +La definición de Mantenimiento Programado es una forma de informar con anticipación a tus usuarios cuando su sistema no puede manejar solicitudes debido a una actualización de mantenimiento temporal. + +Los mantenimientos programados comparten los mismos parámetros que los incidentes regulares, pero siempre son requeridos dos parámetros: [`scheduled`](#scheduled) y [`duration`](#duration). + +Debe tener en cuenta que estas definiciones se manejan de manera diferente a los incidentes regulares: + +- Estos Incidentes Especiales se muestran en la sección **Mantenimiento Programado** (en la página de inicio) mientras la fecha programada ([`scheduled`](#scheduled)) no ha llegado. +- Después que pase la fecha programada ([`scheduled`](#scheduled)), se debe establecer el campo [`resolved`](#resolved) en `true` si la ventana de mantenimiento ha finalizado. +- Los Mantenimientos Programados no se muestran en la **Línea de Tiempo de Incidentes** ni en el **Historial de Incidentes** mientras no haya llegado la fecha programada ([`scheduled`](#scheduled)). + ## Contenido El contenido de los Incidentes se escribe en un formato de Markdown válido, pero hay Extensiones adicionales que proporciona Statusfy. diff --git a/packages/docs/src/guide/incidents.md b/packages/docs/src/guide/incidents.md index f5e0b8b3e..254c7451c 100644 --- a/packages/docs/src/guide/incidents.md +++ b/packages/docs/src/guide/incidents.md @@ -131,6 +131,23 @@ The affected system(s) the incident is referring to. The values that can be used If this field is set to true, the incident is Marked as Resolved. +#### scheduled + +- Type: `string` +- Requirement: `optional` +- Default: `undefined` + +The scheduled start time. This defines the initial of the planned maintenance window. + +#### duration + +- Type: `string` +- Requirement: `optional` +- Default: `undefined` + +The scheduled duration in **minutes**. This defines the duration of the planned maintenance window. + + ### Alternative Front Matter Formats In addition, you can define your front matter as a [JSON](https://en.wikipedia.org/wiki/JSON) or [TOML](https://github.com/toml-lang/toml). @@ -177,6 +194,18 @@ resolved = true Statusfy only supports the [version 0.4.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md) of the TOML specification. ::: +## Scheduled Maintenance + +Scheduled Maintenances definition is a way to let your users know ahead of time when your system(s) cannot handle requests due to a temporary maintenance update. + +Scheduled Maintenances share the same parameters as regular incidents but two parameters are always required: [`scheduled`](#scheduled) and [`duration`](#duration). + +You must keep in mind that these definitions are handled in a different way than regular Incidents: + +- These Special Incidents are displayed in the **Scheduled Maintenance** section (at the Home Page) while the [`scheduled`](#scheduled) date has not arrived. +- After the [`scheduled`](#scheduled) date passes you must set the [`resolved`](#resolved) parameneter to `true` if the maintenance window has finished. +- Scheduled Maintenances are not displayed in the **Incidents Timeline** and the **Incidents History** while the [`scheduled`](#scheduled) date has not arrived. + ## Content The content of the Incidents are written in a valid Markdown format but there are extra Extensions that Statusfy provides.