From 7fa89596696dd712bb42a64fc11b814947b00781 Mon Sep 17 00:00:00 2001 From: Alba Gutierrez Date: Tue, 11 Dec 2018 11:41:48 -0400 Subject: [PATCH] feat(docs): create the Notifications sub-section --- packages/docs/src/.vuepress/config.js | 1 + packages/docs/src/config/README.md | 66 +++++++++++++++++++++ packages/docs/src/es/config/README.md | 65 ++++++++++++++++++++ packages/docs/src/es/guide/README.md | 1 - packages/docs/src/es/guide/notifications.md | 34 +++++++++++ packages/docs/src/guide/README.md | 1 - packages/docs/src/guide/notifications.md | 34 +++++++++++ 7 files changed, 200 insertions(+), 2 deletions(-) create mode 100644 packages/docs/src/es/guide/notifications.md create mode 100644 packages/docs/src/guide/notifications.md diff --git a/packages/docs/src/.vuepress/config.js b/packages/docs/src/.vuepress/config.js index 823670c11..0ba2d4016 100644 --- a/packages/docs/src/.vuepress/config.js +++ b/packages/docs/src/.vuepress/config.js @@ -161,6 +161,7 @@ function genSidebarConfig(title, section = 'guide') { 'configuration', 'i18n', 'incidents', + 'notifications', 'theme-customization', 'pwa', 'api', diff --git a/packages/docs/src/config/README.md b/packages/docs/src/config/README.md index fff3d956e..2143fa969 100644 --- a/packages/docs/src/config/README.md +++ b/packages/docs/src/config/README.md @@ -144,6 +144,72 @@ Provide the Facebook Pixel App ID to enable integration. Provide the Segment Token to enable integration. +## notifications + +- Type: `object` +- Default: `{}` + +The available notifications options. + +### icalendar + +- Type: `boolean` +- Default: `true` + +Activate the calendar containing all of your upcoming and past Scheduled Maintenances. For more details, see the guide on [Notifications](../guide/notifications.md#icalendar). + +### feeds + +- Type: `boolean` +- Default: `true` + +Activate the feeds that include all past Incidents and Scheduled Maintenances. For more details, see the guide on [Notifications](../guide/notifications.md#atom-and-rss-feeds). + +### twitter + +- Type: `object` +- Default: `undefined` + +Define Twitter accounts that your users can access in order to receive updates. + +You must define a value for each language your system supports: + +```json +... + notifications: { + twitter: { + en: "BazziteTech", + es: "BazziteES" + } + } +... +``` + +For more details, see the guide on [Notifications](../guide/notifications.md#twitter). + +### support + +- Type: `object` +- Default: `undefined` + +Define the external Support Sites your users can access in order to receive updates from other sources you may want to provide. + +You must define a value for each language your system supports: + +```json +... + notifications: { + support: { + en: "https://statusfy.co/support", + es: "https://statusfy.co/es/support" + } + } +... +``` + +For more details, see the guide on [Notifications](../guide/notifications.md#support-site). + + ## defaultLocale - Type: `string` diff --git a/packages/docs/src/es/config/README.md b/packages/docs/src/es/config/README.md index ac18fb470..aeef1c8a1 100644 --- a/packages/docs/src/es/config/README.md +++ b/packages/docs/src/es/config/README.md @@ -151,6 +151,71 @@ Proporciona el Facebook Pixel App ID para habilitar la integración. Proporciona el token de Segment para habilitar la integración. +## notifications + +- Type: `object` +- Default: `{}` + +Las opciones de notificaciones disponibles. + +### icalendar + +- Type: `boolean` +- Default: `true` + +Activa calendario que contiene todos tus Mantenimientos Programados futuros y pasados. Para más detalles, consulta la guía de [Notificationes](../guide/notifications.md#icalendar). + +### feeds + +- Type: `boolean` +- Default: `true` + +Activa feeds incluyen todos los incidentes Mantenimientos Programados que han pasado. Para más detalles, consulta la guía de [Notificationes](../guide/notifications.md#feeds-atom-y-rss). + +### twitter + +- Type: `object` +- Default: `undefined` + +Define las cuentas de Twitter a las que tus usuarios pueden acceder para recibir actualizaciones. + +Debes definir un valor para cada idioma que soporte tu sistema: +```json +... + notifications: { + twitter: { + en: "BazziteTech", + es: "BazziteES" + } + } +... +``` + +Para más detalles, consulta la guía de [Notificationes](../guide/notifications.md#twitter). + +### support + +- Type: `object` +- Default: `undefined` + +Define los sitios de Soporte Externo al que puedan acceder tus usuarios para recibir actualizaciones de otras fuentes que desees proporcionar. + +Debes definir un valor para cada idioma que soporte tu sistema: + +```json +... + notifications: { + support: { + en: "https://statusfy.co/support", + es: "https://statusfy.co/es/support" + } + } +... +``` + +Para más detalles, consulta la guía de [Notificationes](../guide/notifications.md#sitio-de-soporte). + + ## defaultLocale - Tipo: `string` diff --git a/packages/docs/src/es/guide/README.md b/packages/docs/src/es/guide/README.md index bdd8567ce..7557f51e9 100644 --- a/packages/docs/src/es/guide/README.md +++ b/packages/docs/src/es/guide/README.md @@ -30,7 +30,6 @@ La aplicación web final se puede [generar o construir](../guide/deploy.md) a pa Statusfy es todavía un trabajo en progreso. Hay algunas cosas que actualmente no están soportadas pero están planeadas: -- Feeds Atom y RSS. - Notificaciones: Web Push, Webhooks, etc. - Una GUI de Statusfy: crea y administra tu proyecto de una manera más fácil. - Métrica. diff --git a/packages/docs/src/es/guide/notifications.md b/packages/docs/src/es/guide/notifications.md new file mode 100644 index 000000000..e676fb3b4 --- /dev/null +++ b/packages/docs/src/es/guide/notifications.md @@ -0,0 +1,34 @@ +# Notificaciones + +Las notificaciones son una forma de mantener a sus usuarios/clientes notificados con cualquier actualización de Incidentes que pueda tener tu Sistema. Los espectadores de su página de estado pueden acceder a las siguientes opciones haciendo clic en el botón Suscribirse. + +::: tip +La mayoría de estas opciones de notificación están habilitadas de forma predeterminada, pero puedes deshabilitarlas en tu archivo de configuración. Más información [aquí](../config/README.md#notifications). +::: + +## Feeds Atom y RSS + +Estos feeds incluyen todos los incidentes Mantenimientos Programados que han pasado. Tus usuarios/clientes pueden usar lectores de feeds o herramientas como [IFTT][iftt-rss] y [Zapier][zapier-rss] para recibir notidicaciones de estos feeds. + +## iCalendar + +Sus usuarios/clientes pueden suscribirse a un calendario que contiene todos sus Mantenimientos Programados futuros y pasados. El calendario se publica utilizando iCalendar, un formato popular que es compatible con la mayoría de las aplicaciones de calendario modernas. + +Estos son los eventos que se incluyen en el Calendario: + +- Todos los Mantenimientos Programados activos y completados. +- Todos los Mantenimientos Programados futuros. + + +## Twitter + +Actualmente, con esta opción, puede definir las cuentas de Twitter a las que tus usuarios pueden acceder para recibir actualizaciones. + +## Sitio de Soporte + +Define un sitio de soporte externo al que puedan acceder tus usuarios para recibir actualizaciones de otras fuentes que desees proporcionar. + + + +[iftt-rss]: https://ifttt.com/feed +[zapier-rss]: https://zapier.com/apps/rss/integrations diff --git a/packages/docs/src/guide/README.md b/packages/docs/src/guide/README.md index 657283c2b..412926eb7 100644 --- a/packages/docs/src/guide/README.md +++ b/packages/docs/src/guide/README.md @@ -26,7 +26,6 @@ The final Web Application can be [generated or built](../guide/deploy.md) from a Statusfy is still a work in progress. There are a few things that are not currently supported but are planned: -- Atom and RSS Feeds. - Notifications: Web Push, Webhooks, etc. - A Statusfy GUI: create and manage your project in an easier way. - Metrics. diff --git a/packages/docs/src/guide/notifications.md b/packages/docs/src/guide/notifications.md new file mode 100644 index 000000000..8017db4c7 --- /dev/null +++ b/packages/docs/src/guide/notifications.md @@ -0,0 +1,34 @@ +# Notifications + +Notifications are a way to keep your users/customers notified with any Incidents update your System may have. Viewers of your Status Page can access the Choices bellow by clicking the Subscribe button. + +::: tip +Most of these Notifications Features are enabled by default but you can disable them in your config file. More info [here](../config/README.md#notifications). +::: + +## Atom and RSS Feeds + +These feeds include all past Incidents and Scheduled Maintenances. Your users/customers can use Feeds Readers or tools like [IFTT][iftt-rss] and [Zapier][zapier-rss] to recieve updates from these feeds. + +## iCalendar + +Your users/customers can subscribe to a calendar containing all of your upcoming and past Scheduled Maintenances. The calendar is published using iCalendar, a popular format which is supported by most modern calendar applications. + +These are the events that are included in the Calendar: + +- All active and completed Scheduled Maintenances. +- All upcoming Scheduled Maintenances. + + +## Twitter + +Currently, with this option, you can define Twitter accounts that your users can access in order to receive updates. + +## Support Site + +Define an external Support Site your users can access in order to receive updates from other sources you may want to provide. + + + +[iftt-rss]: https://ifttt.com/feed +[zapier-rss]: https://zapier.com/apps/rss/integrations