Páginas publicadas para documentação?

Estou com dúvidas sobre estas páginas publicadas.
Contexto: Tenho muita documentação no Google Docs. Como parte da mudança da nossa comunidade do Facebook para o Discourse, estamos aproveitando a oportunidade para mover a documentação para o Discourse também.

As pessoas adoravam que a documentação fosse pública e “semelhante ao Word”, imprimiam os arquivos para referência, levavam cópias ao veterinário ou enviavam links por e-mail.

Para mim, a principal vantagem da funcionalidade de Publicação de Página é que ela nos permite tornar público algo que de outra forma teria sido privado. Mas se, como será o meu caso, a documentação já está em uma categoria que será pública, faz sentido publicá-la também?

Os URLs são um pouco mais bonitos. Há menos “móveis do Discourse” na página, o que é bom (mas, por outro lado, exige adicionar um rodapé ou algo para indicar que é um documento da comunidade… não é grande coisa).

Mas onde realmente estou começando a ver um problema é nos muitos links que temos dentro dos documentos que apontam para outros documentos (oba, hipertexto). Se eu usar os URLs de “página publicada”, os membros da comunidade que estão lendo a documentação são retirados da comunidade de certa forma e podem não conseguir encontrar o caminho de volta. Se usarmos os URLs de “tópico do Discourse”, então os leitores externos vão parar em páginas do Discourse, completos com respostas e (no meu caso, pelo menos, talvez eu possa mudar isso?) uma longa lista de novos tópicos não lidos para analisar.

Aqui está um exemplo:

Quem já enfrentou um dilema semelhante? Como vocês resolveram? Existem funcionalidades aqui que poderiam me ajudar, mas que eu talvez não conheça?

Agradeço antecipadamente pela sua opinião.

3 curtidas

Eu não tenho respostas; mas o recurso de publicação de página, embora faça o que foi projetado para fazer, carece profundamente de funcionalidades. Não estou convencido de que este seja o caminho a seguir para o seu propósito :thinking:

3 curtidas

De fato! Você acabou de elucidar o principal caso de uso da publicação de página (tornar conteúdo privado público) - e sua principal limitação (confusão de links e falta de navegação). Basta usar sua categoria pública e estilizar um pouco, se necessário. Você pode achar Discourse Doc Categories útil para navegação.

3 curtidas

Ainda estou um pouco ambivalente. Eu acho que para certos documentos, seria melhor (se a pessoa não estiver conectada ao Discourse) que a barra lateral, os tópicos não lidos e outras coisas estivessem ausentes. Fica mais parecido com um “documento” assim. Haveria uma maneira de exibi-lo assim para usuários que não são do Discourse, mas exibi-lo “com os elementos do Discourse” quando logado? Com a mesma URL?

Haveria soluções para explorar com o WordPress (eu ainda não olhei como eles interagem), mas uma página do WordPress poderia ser “espelhada” no Discourse como um tópico, por exemplo?

2 curtidas

Definitivamente. Dê uma olhada em WP Discourse – WordPress plugin | WordPress.org. Não é oficial, mas há uma categoria para isso: Support > WordPress

Você pode ver isso ao vivo em https://monocycle.info, os artigos são postados automaticamente no fórum https://forum.monocycle.info/c/actualites/47

1 curtida

Aviso de que movi isto para um novo tópico – acho que é valioso.

Devo estar perdendo uma nuance – por que você não pode simplesmente tornar tópicos privados públicos em vez de usar a publicação de páginas? Você poderia usar permalinks se a URL for tão importante. Veja como https://meta.discourse.org/fun redireciona para https://meta.discourse.org/t/discourse-stickers/390126.

3 curtidas

Nenhum destes URLs está acessível para mim. Isso é intencional?

2 curtidas

Heh, isso foi idiota da minha parte. Eles estão em uma categoria privada. Vou encontrar um exemplo melhor. (Editado.)

2 curtidas

Obrigado por levantar isso! Isso pode ser específico do tópico que minha comunidade aborda. Além das informações que eles fornecem, percebemos que o fato de nossos documentos parecerem “documentos reais” e não “páginas da web” nos ajuda a sermos levados a sério. Nossos membros podem imprimir um documento que se parece com “um artigo sério” e mostrá-lo aos seus veterinários –– esse “público secundário” (que na verdade é muito importante, mesmo que não sejam participantes muito ativos em nossa comunidade) provavelmente terá, como a maioria da profissão médica, fortes preconceitos negativos em relação a “coisas na internet”.

Então, minha preocupação é que ter nossa documentação com a aparência de “algo em um fórum da internet (omg)” mudará a forma como ela é percebida pelos membros de fora da nossa comunidade.

Você vê o problema?

Ah, obrigado, não sabia/esqueci que essa era uma opção! Com certeza vou usá-la.

Acho que algumas ideias que poderiam me ajudar a sair do meu atual dilema de documentação seriam:

  • ter um layout específico da categoria de documento dentro do tema (ou, mais geralmente, ser capaz de escolher uma aparência/layout diferente para uma categoria específica)
  • ser capaz de exibir as coisas de forma diferente em algumas categorias para visitantes não logados (ou até mesmo, por TL?)
  • ser capaz de adicionar algum “mobiliário do discourse” às Páginas Publicadas quando visualizadas por um usuário logado (mas removido ao imprimir, é claro)

Apenas alguns pensamentos de manhã nebulosa!

1 curtida

Aqui estão algumas variações de uma maneira fácil de resolver isso sem o “mobiliário” do Discourse: forneça um link no tópico para a página de índice da sua documentação. (Os usuários podem nem sempre ter vindo da página de índice — mas pelo menos eles voltarão para onde podem navegar.)

Adicionar um link de índice

Se você sempre vinculará às páginas publicadas (que realmente parecem muito melhores para impressão), então pode ser tão simples quanto isso — apenas comece o conteúdo de cada tópico individual com um link de volta para a sua página de índice:

[Toute la documentation DF](https://entraide.diabete-felin.com/t/toute-la-documentation-df)

Que tu te sentes prêt·e à te lancer...

ou

Adicionar um link de índice oculto internamente

Se você às vezes vinculará às páginas publicadas, mas também às vezes vinculará aos tópicos reais, você pode querer ocultar o link do índice internamente:

Adicione um wrap em torno de um link para o índice da sua FAQ/documentos:

[wrap=index-link]
[Toute la documentation DF](https://entraide.diabete-felin.com/t/toute-la-documentation-df)
[/wrap]

Que tu te sentes prêt·e à te lancer...

O código [wrap] permite que este trecho de CSS personalizado oculte esse link quando o tópico regular é visualizado:

article [data-wrap="index-link"] {
  display: none;
}

Mas o link ainda aparecerá na página publicada, para que os leitores possam retornar facilmente ao fórum.

Obrigado, isso parece útil! Certamente faremos referência às páginas de tópicos em nossas discussões, já que o objetivo de tê-las no Discourse é facilitar a referência a elas para as pessoas.

Oi, acabei de tentar isso, mas estes são realmente redirecionamentos, não permalinks, certo? Ou existe uma maneira de fazer com que o “link permanente” seja aquele exibido quando o destino é carregado?

Outro problema que estou tendo é que a versão de impressão para a Página Publicada não está boa como está (mas ainda preciso trabalhar nos estilos de tela). Isso é um problema de Tema? Se eu quiser melhorar o CSS de impressão, onde devo fazer isso?

1 curtida

Sim, esses são redirecionamentos (por que não foram nomeados como tal desde o início? :thinking:), e não, não é possível manter a mesma URL. Talvez com um plugin personalizado…

1 curtida

A visualização de impressão carrega discourse/app/assets/stylesheets/common/base/crawler_layout.scss at main · discourse/discourse · GitHub. Não tenho certeza se há outro CSS específico para impressão.

Você pode segmentar com a classe crawler do corpo. Ou sugira alterações em Contribute > Feature se você acha que isso pode beneficiar toda a comunidade :slight_smile:

edite: existe discourse/app/assets/stylesheets/common/printer-friendly.scss at main · discourse/discourse · GitHub

Pelo que entendi, crawler_layout.scss é aplicado especificamente ao layout do crawler. Páginas sem o layout do crawler ainda carregam printer-friendly.scss quando abrimos a janela de impressão.

Para personalizações, use a media query @media print {.

Por favor, me corrija se eu estiver errado.

1 curtida