Skip to content
This repository has been archived by the owner on Jun 13, 2022. It is now read-only.

Commit

Permalink
feat(docs): create the Notifications sub-section
Browse files Browse the repository at this point in the history
  • Loading branch information
Alba Gutierrez committed Dec 11, 2018
1 parent cbc5539 commit 7fa8959
Show file tree
Hide file tree
Showing 7 changed files with 200 additions and 2 deletions.
1 change: 1 addition & 0 deletions packages/docs/src/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ function genSidebarConfig(title, section = 'guide') {
'configuration',
'i18n',
'incidents',
'notifications',
'theme-customization',
'pwa',
'api',
Expand Down
66 changes: 66 additions & 0 deletions packages/docs/src/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,72 @@ Provide the Facebook Pixel App ID to enable integration.

Provide the Segment Token to enable integration.

## notifications <Badge text="0.2.0+"/>

- Type: `object`
- Default: `{}`

The available notifications options.

### icalendar <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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`
Expand Down
65 changes: 65 additions & 0 deletions packages/docs/src/es/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Badge text="0.2.0+"/>

- Type: `object`
- Default: `{}`

Las opciones de notificaciones disponibles.

### icalendar <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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 <Badge text="0.2.0+"/>

- 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`
Expand Down
1 change: 0 additions & 1 deletion packages/docs/src/es/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
34 changes: 34 additions & 0 deletions packages/docs/src/es/guide/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Notificaciones <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

Actualmente, con esta opción, puede definir las cuentas de Twitter a las que tus usuarios pueden acceder para recibir actualizaciones.

## Sitio de Soporte <Badge text="0.2.0+"/>

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
1 change: 0 additions & 1 deletion packages/docs/src/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
34 changes: 34 additions & 0 deletions packages/docs/src/guide/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Notifications <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

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 <Badge text="0.2.0+"/>

Currently, with this option, you can define Twitter accounts that your users can access in order to receive updates.

## Support Site <Badge text="0.2.0+"/>

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

0 comments on commit 7fa8959

Please sign in to comment.