search

bolhaverso / colab

manutenção reativa e cotidiana da bolha
0 stars 0 forks source link

Subir um mkdocs com material para o docs.bolha.io #15

Open gutocarvalho opened 1 year ago

gutocarvalho commented 1 year ago

A ideia é ter algo parecido com isso

https://community.hachyderm.io/docs/

gutocarvalho commented 1 year ago

isso aqui vai ser a base para os sites.

conduta.bolha.io privacidade.bolha.io

droposhado commented 11 months ago

Vi que tem o respositório do docs

Tem alguns outros que acho que vão usar de base também?

Minha sugestão é centralizar tudo, gerar diagrama, os posts do WriteFreely ou migrar ou apenas indexar os links no docs pros posts, senão vai chegar uma hora que vai faltar braço pra manutenção, fora que fica muita coisa pra quem está atualmente gerenciando tudo manter .

Sites dispersos dificultam mandar os how to pras pessoas, considerando que elas tem diversos níveis técnicos, que a galera mais mão na massa pode ser mais iniciante igual eu, que precisaria ou de assistência ou de coisa escrita pra seguir, procurar coisas se torna exaustivo e desistem.

E nesse site de docs, implementar o deploy usando github actions com essa action de deploy, assim, todos os PRs que chegar, já consegue colocar em prod, agilizando todo o processo e abrindo pra galera fazer correção.

Na minha opnião isso facilita a entrada de pessoas e a curva inicial, qdo eu entrei tinha umas dúvidas, hoje entrou mais uma pessoa com as mesmas perguntas.

A principio consigo fazer a action e deixar funcionando o deploy, precisaria fazer o apontamento de CNAME pro Gh Pages. O que eu conseguir ir fazendo, vou escrevendo.

Pros diagramas pensei em usar o https://diagrams.mingrammer.com/, já usei e achei maneiro, apesar de ser Python, é quase low code.

O que acham?

ayr-ton commented 10 months ago

@droposhado Voto por centralizar também pra facilitar a administração do código e das pipelines. Tem um plugin pro mkdocs que suporta a renderizar mermaid.js direto no markdown. Posso subir numa página de exemplo pra cês testarem.

ayr-ton commented 10 months ago

Criar uns redirects de subdomínios pra páginas no docs pode ser uma boa se ainda quisermos usar os links mas aproveitar a base do docs.

ayr-ton commented 10 months ago
droposhado commented 10 months ago

@droposhado Voto por centralizar também pra facilitar a administração do código e das pipelines. Tem um plugin pro mkdocs que suporta a renderizar mermaid.js direto no markdown. Posso subir numa página de exemplo pra cês testarem.

Estou utilizando esse mermaid.js no mkdocs pra uma wiki pessoal e funciona bem, fica legal, tem dark mode tbm