Escribir notificaciones en Sensedia Docs te permite mantener a tu equipo informado sobre actualizaciones importantes, cambios o alertas relacionadas con tu documentación. Esta guía te ayudará a entender cómo crear y gestionar notificaciones de manera efectiva.
A diferencia de la documentación, las notificaciones no se escriben en archivos markdown. En su lugar, usamos archivos .yaml para definir las notificaciones. Estos archivos se encuentran en el directorio notifications de tu proyecto Sensedia Docs.
Un archivo YAML de notificación normalmente incluye los siguientes campos:
title: El título de la notificación.message: El contenido de la notificación.link: Un enlace URL relacionado con la notificación.El identificador de la notificación se genera automáticamente según el nombre del archivo. Por ejemplo, si creas un archivo llamado update-notification.yaml, el ID de la notificación será update-notification.
Aquí tienes un ejemplo de una notificación definida en un archivo YAML:
Para agregar una notificación, crea un nuevo archivo YAML en el directorio notifications con los detalles deseados. Asegúrate de que el nombre del archivo sea descriptivo, ya que se usará como identificador de la notificación.
Las notificaciones son autogestionadas por Sensedia Docs. Una vez que creas un archivo YAML de notificación, será procesado automáticamente y mostrado en la sección de notificaciones de tu sitio de documentación. Las notificaciones también se eliminan de la interfaz de usuario cuando expiran o dejan de ser relevantes, según las reglas de fecha y visualización.
Para ver las notificaciones, navega a la sección de notificaciones de tu sitio Sensedia Docs. Aquí verás una lista de todas las notificaciones activas, incluyendo sus títulos y mensajes. Al hacer clic en una notificación se marcará como leída, y al hacer clic en el enlace irás a la documentación relevante.
Las notificaciones pueden ser localizadas creando archivos YAML separados para cada idioma que soportes. El archivo debe estar en el directorio de idioma correspondiente, por ejemplo: notifications/en/update-notification.yaml para inglés. La estructura permanece igual, pero el contenido estará traducido al idioma respectivo.
Para eliminar una notificación, simplemente elimina el archivo YAML correspondiente del directorio notifications. La notificación se eliminará de la interfaz de usuario en la siguiente actualización.
Actualmente, Sensedia Docs no soporta la programación de notificaciones. Las notificaciones se muestran inmediatamente después de ser agregadas y permanecen hasta que se eliminan o expiran.
Las notificaciones expiradas se eliminan automáticamente de la interfaz de usuario. Puedes gestionar la visibilidad de las notificaciones estableciendo fechas apropiadas en el archivo YAML si es necesario.
La apariencia de las notificaciones es gestionada por Sensedia Docs y no puede ser personalizada directamente. Sin embargo, puedes controlar el contenido y la estructura de las notificaciones a través de los archivos YAML.
Nuestro sitio web utiliza cookies para habilitar funcionalidades básicas de evaluación y notificaciones. No utilizamos cookies de seguimiento para publicidad ni análisis de terceros.Aprender más