Melhores práticas: separadores ascii em e-mails?

Suporte
1

Olá, Comunidade Discourse —

Primeiro, obrigado por criar uma ferramenta que estou achando excelente, valiosa, flexível e (na maioria das vezes) intuitiva. Estamos trabalhando para mudar várias modalidades de comunicação do nosso projeto para o uso do Discourse, desde listas de discussão baseadas em usuários até e-mails gerados por scripts que nos notificam sobre eventos importantes (novos problemas, falhas de teste, etc.), e estamos animados com as mudanças.

Um dos obstáculos que encontrei ao configurar as coisas é a remoção automática do conteúdo que segue linhas como ----- em e-mails enviados ao Discourse. Se entendi corretamente, isso é feito para evitar que posts feitos por e-mail carreguem toda a cadeia de respostas junto, e tenho ficado impressionado com a forma limpa como as respostas por e-mail são renderizadas no Discourse, então não estou questionando essa escolha de forma alguma nesta pergunta.

Tradicionalmente, usamos esses separadores com frequência em e-mails de notificação gerados por scripts (que agora estamos refletindo para o Discourse) para torná-los fáceis de ler, seja com tecnologias antigas ou modernas. Estou no processo de removê-los e substituí-los por técnicas como “vamos tentar usar mais espaço vertical em branco”, mas antes de avançar muito nesse esforço, queria verificar se há alguma outra prática recomendada para criar tais separadores em e-mails enviados ao Discourse, ou alguma maneira de escapar deles / contornar o filtro atual que eu não tenha encontrado (minha melhor tentativa até agora foi usar uma linha de travessões encurtados em vez de hífens/traços ASCII, mas não estou muito a favor de usar caracteres não ASCII, por simplicidade).

Vários de nós também tendemos a usar habitualmente pequenos separadores --- em e-mails para separar um bloco de código ou algo assim, então me preocupo que, mesmo depois de converter todas as nossas mensagens geradas por scripts, isso possa afetar usuários que dependem da opção de responder para responder a tópicos do Discourse refletidos em suas caixas de entrada (mas talvez seja apenas uma curva de aprendizado que precisaremos superar?).

Obrigado por qualquer dica ou conselho aqui,
-Brad

2

Aha… algo que acabei de descobrir e que pode ajudar outras pessoas que acabarem chegando a este tópico: misturar símbolos ASCII que não são separadores ou pontuação em uma linha que, de outra forma, atua como separador faz com que ela passe pelo filtro do Discourse. Então, alterar uma linha como:

Header
--------------------------------

Para:

--- Header ---------------------

é uma maneira de preservar alguma forma de linha separadora sem que o Discourse a remova. Claro, isso ainda não ajuda usuários acostumados a depender de pequenas linhas separadoras ---- para destacar algo em um e-mail, então ainda tenho curiosidade se outras pessoas têm práticas recomendadas sobre isso.

3

Correndo o risco de continuar falando sozinho, aqui está um exemplo motivador específico que encontramos hoje:

Um dos casos em que usamos scripts para notificar pessoas sobre eventos é enviar e-mails aos desenvolvedores quando novos PRs são mesclados em nosso repositório do GitHub. Agora, modificamos esses scripts para enviar e-mails a uma categoria específica em nosso site Discourse. No entanto, como o GitHub usa markdown para descrever os PRs, frequentemente temos cabeçalhos de seção como o seguinte nas descrições dos PRs:

Detalhes deste PR
------------------

que são renderizados como cabeçalhos de seção no GitHub. Mas, quando enviados por e-mail para o Discourse, essa linha de traços faz com que o restante da mensagem seja cortado.

Podemos, obviamente, treinar todos os nossos desenvolvedores a usar outros estilos de cabeçalhos que não seriam cortados (como ## Detalhes deste PR), mas se houvesse alguma maneira de modificar nosso script para processar a mensagem de mesclagem e proteger ou escapar esses padrões, de modo que fossem preservados até o Discourse, isso pareceria mais atraente.