Escrever notificações no Sensedia Docs permite que você mantenha sua equipe informada sobre atualizações importantes, mudanças ou alertas relacionados à sua documentação. Este guia irá ajudá-lo a entender como criar e gerenciar notificações de forma eficaz.
Diferente da documentação, as notificações não são escritas em arquivos markdown. Em vez disso, usamos arquivos .yaml para definir notificações. Esses arquivos ficam localizados no diretório notifications do seu projeto Sensedia Docs.
Um arquivo YAML de notificação normalmente inclui os seguintes campos:
title: O título da notificação.message: O conteúdo da notificação.link: Um link relacionado à notificação.Assim como na documentação, o identificador da notificação é gerado automaticamente com base no nome do arquivo. Por exemplo, se você criar um arquivo chamado update-notification.yaml, o ID da notificação será update-notification.
Veja um exemplo de notificação definida em um arquivo YAML:
Para adicionar uma notificação, crie um novo arquivo YAML no diretório notifications com os detalhes desejados. Certifique-se de que o nome do arquivo seja descritivo, pois ele será usado como identificador da notificação.
As notificações são autogerenciadas pelo Sensedia Docs. Assim que você cria um arquivo YAML de notificação, ele será processado automaticamente e exibido na seção de notificações do seu site de documentação. As notificações também são removidas da interface do usuário quando expiram ou deixam de ser relevantes, conforme regras de data e visualização.
Para visualizar notificações, acesse a seção de notificações do seu site Sensedia Docs. Lá, você verá uma lista de todas as notificações ativas, incluindo seus títulos e mensagens. Ao clicar em uma notificação, ela será marcada como lida; ao clicar no link, você será direcionado para a documentação relevante.
As notificações podem ser localizadas criando arquivos YAML separados para cada idioma que você suporta. O arquivo deve estar no diretório do idioma correto, exemplo: notifications/en/update-notification.yaml para inglês. A estrutura permanece a mesma, mas o conteúdo será traduzido para o respectivo idioma.
Para excluir uma notificação, basta remover o arquivo YAML correspondente do diretório notifications. A notificação será removida da interface do usuário após a próxima atualização.
Atualmente, o Sensedia Docs não suporta agendamento de notificações. As notificações são exibidas imediatamente após serem adicionadas e permanecem até serem removidas ou expirarem.
Notificações expiradas são removidas automaticamente da interface do usuário. Você pode gerenciar a visibilidade das notificações definindo datas apropriadas no arquivo YAML, se necessário.
A aparência das notificações é gerenciada pelo Sensedia Docs e não pode ser personalizada diretamente. No entanto, você pode controlar o conteúdo e a estrutura das notificações através dos arquivos YAML.
Nosso site utiliza cookies para habilitar funcionalidades essenciais de avaliação e notificações. Não utilizamos cookies de rastreamento para publicidade ou análise de terceiros.Saiba mais