Partkeepr: Partkeepr Wiki

Criado em 12 abr. 2019  ·  26Comentários  ·  Fonte: partkeepr/PartKeepr

Não diretamente relacionado à base de código - mas o wiki Partkeepr não está mais disponível em
https://wiki.partkeepr.org/
Não sei se isso foi arquivado em algum lugar, mas é um recurso muito útil e gostaria de vê-lo restaurado, se possível.

meta

Comentários muito úteis

Parece que o wiki está online novamente.

Todos 26 comentários

Por enquanto, a única coisa que consegui fazer "funcionar" é usar páginas em cache do Google. Você simplesmente procura por uma página wiki relevante, o google mostra um resultado e, em vez de clicar no link em si, clica na pequena seta para baixo ao lado dela e depois clica em cache. Não terá estilo, mas o conteúdo está lá. Ou acesse archive.org: http://web.archive.org/web/20180310044536/http : //wiki.partkeepr. org: 80 / wiki / Main_Page

Espero que em algum momento o wiki volte, mesmo que apenas como html vazio em uma pasta no github (ou na guia wiki aqui).

Parece que o wiki está online novamente.

Excelente notícia! Fechando.

De qualquer forma, alguém sabe onde o wiki está hospedado? Isso ainda é responsabilidade de @Drachenkaetzchen? Em outra edição é descrito o problema do Partkeepr estar um pouco preso no momento. Pode ser uma boa maneira de ajudar @Drachenkaetzchen e assumir a responsabilidade por isso em outros ombros. Então, um backup do Wiki / SQL é necessário.

@ Gasman2014 Em

Estou com @christianlupus , diria que hospedá-lo na seção wiki dos githubs, isso deve tirar um pouco da carga dos servidores e ombros de @Drachenkaetzchen .

Tendo em vista o desejo de uma solução de longo prazo e as sugestões de @ C44Supra e @christianlupus para tentar apoiar Felicia @Drachenkaetzchen arquivando esses dados e hospedando-os independentemente via github, estou reabrindo isto. As informações no wiki são muito úteis para solucionar problemas de instalações - particularmente em situações de nicho não descritas no guia de configuração principal. Essas informações devem estar disponíveis junto com a base de código para máxima usabilidade. Estou muito satisfeito em ver que o wiki foi restaurado, mas talvez pudesse, sem muito trabalho, ser combinado com a seção wiki do github, que também contém algumas informações úteis, mas adicionais e diferentes.

Se alguém puder fornecer uma maneira de mover automaticamente o wiki hospedado para o GitHub, vá em frente e me avise, mas apenas se você realmente testou esse mecanismo. Um simples google produz muitos resultados para esse mecanismo, e não tenho tempo nem energia para examiná-los.

Se você precisar de algum tipo de acesso à API para o wiki atual ou um despejo de banco de dados, por favor me avise.

Eu estaria disposto a tentar preparar isso. Vou tentar migrar para um wiki em minha conta pessoal. Pelo que vi, só posso migrar a versão mais recente do wiki e alguns ajustes manuais são necessários.

Tentei migrar os arquivos wiki para o github. O resultado é visível neste repo . Ainda existem algumas pequenas modificações necessárias (como remover erros de digitação, renomear páginas, organizar arquivos, etc.).

Infelizmente, a exportação automática para XML (forma padrão de exportar do mediawiki) tem algumas desvantagens. Dessa forma, o histórico das páginas é perdido e nenhum arquivo de mídia é exportado. Baixei-os manualmente, mas os metadados (como o título e o texto alternativo) não foram transferidos. Além disso, o wiki do github é um pouco mais restrito do que o Mediawiki, tornando, por exemplo, listas de subpáginas impossíveis, até onde eu descobri.

@Drachenkaetzchen Eu gostaria que você verificasse se o wiki pode ser usado desta forma. Então, você pode simplesmente instalar as páginas do meu repositório na página do Partkeepr se estiver tudo bem para você. Em caso de dúvidas, entre em contato. Ficarei muito satisfeito e orgulhoso em ajudar.
PS: Eu adicionei você como um colaborador do repo para que você possa brincar com ele.

Todos os outros são convidados a procurar na wiki os erros que perdi.

@Drachenkaetzchen Eu gostaria que você verificasse se o wiki pode ser usado desta forma.

Estou confuso, o que exatamente devo verificar?

Transferi o wiki para o github. Verifique se este trabalho é aceitável pelos seus padrões de qualidade e não estraguei completamente.

Acho que você deve perguntar aos usuários;) Raramente uso o wiki.

Sugiro pedir feedback na lista de discussão

Deixei uma mensagem na lista de discussão . Referência cruzada aqui apenas para conclusão.

Eu sugiro que usemos o github Pages em vez de um github wiki. Teríamos mais opções de organização de arquivos lá e não há grande diferença entre as duas soluções. Há alguma opção de que um wiki do github seja mais adequado?

@Drachenkaetzchen Não recebi muita atenção e resposta de outros usuários em relação à migração do wiki. Você tem alguma programação ou como procederíamos aqui? Eu prepararia a migração em termos de fazer os links funcionarem e os nomes de arquivo úteis. Como se trata de um trabalho manual, prefiro não fazê-lo, quando não for usado posteriormente.

Eu realmente não posso dar nenhum feedback. Eu só sou capaz de fazer coisas administrativas básicas para o projeto.

OK, então peço a @dromer para dar sua opinião.

Olá a todos, não vi nenhuma discussão sobre como migrar o wiki para o github.

Eu acho que faz sentido concentrar todas as informações que temos em um único recurso. Mas também as informações sobre as quais migramos devem ser relevantes e eliminadas de coisas legadas.

Minha experiência com github wiki e páginas é praticamente inexistente, então não posso comentar sobre isso.

[editar: páginas ah seriam como um site jekyll ou algo assim. alguma preferência por um autoformatador, então?]

páginas ah seriam como um site jekyll ou algo assim.

Yop, é basicamente isso. O wiki aliás também. A diferença é que as páginas se destinam a ser usadas para um site, enquanto o wiki para um conjunto aproximado de blocos mais ou menos curtos de informação que não são classificados / organizados. Isso me fez (durante meu primeiro teste de migração) causar alguns problemas, pois os nomes dos arquivos são automaticamente adivinhados pelo servidor subjacente, por exemplo, a diferenciação de maiúsculas e minúsculas causou problemas.

O que você quer dizer com sua frase

alguma preferência por um autoformatador então?

Você quer dizer o estilo / layout?

Desculpe, eu quis dizer o gerador de sites. Eu acredito que as páginas do github podem usar outros além do jekyll?

Não tenho certeza se jekyll será a maneira mais fácil / legal de organizar um wiki, qual seria a vantagem sobre o wiki do github exatamente?

Não acho que devamos necessariamente hospedar o site principal do partkeepr ainda, vamos nos concentrar em recursos de informação atualizados como o wiki.

Existem algumas páginas fragmentadas no wiki do github também, eu acho. Tudo isso deve ser convergido apenas com informações relevantes e corretas para o estado atual do projeto.

Desculpe, eu quis dizer o gerador de sites. Eu acredito que as páginas do github podem usar outros além do jekyll?

Sem problemas. Pode ser, ainda não resolvi completamente.

Não tenho certeza se jekyll será a maneira mais fácil / legal de organizar um wiki, qual seria a vantagem sobre o wiki do github exatamente?

Bem, a diferença é pequena para ser honesto, tanto quanto eu vejo. Ambos pegam a marcação (ou qualquer formato que o pandoc possa ler) e formatam de uma maneira agradável.
Eu encontrei o problema, que o wiki não permite namespaces e o mapeamento entre links e o nome do arquivo correspondente é uma espécie de heurística:

  • O wiki contém duas páginas que diferem apenas no caso de seus títulos ( 1 , 2 ). Tive que remover manualmente um deles para fazer a heurística selecionar o correto.
  • Subpastas (usadas como uma espécie de namespacing) só podem ser criadas durante o check-out usando git manualmente. Os links não respeitam esse namespacing, portanto, você só pode ter cada nome de arquivo uma vez, tornando a estrutura de pastas contra-prática. Não sei como o github seleciona a página a ser nomeada caso dois arquivos tenham o mesmo nome.

Uma vantagem adicional da solução github Pages é que você pode executar o jekyll localmente para verificar a aparência e todos os links sem publicar ainda. Também acho que você poderia fazer mais estilização (mas eu teria que dar uma olhada nisso).

Não acho que devamos necessariamente hospedar o site principal do partkeepr ainda, vamos nos concentrar em recursos de informação atualizados como o wiki.

Não, acho que está localizado em uma boa localização no momento.
Embora eu deva salientar que havia (?) A ideia de usar o github para a página inicial principal. Se houver necessidade, pode-se migrar para o github (se a situação financeira de Drachenkaetzchen piorar e ela tiver problemas para pagar pelo servidor).

O ponto principal deste problema é preservar o wiki atual no caso de os servidores caírem.

Existem algumas páginas fragmentadas no wiki do github também, eu acho. Tudo isso deve ser convergido apenas com informações relevantes e corretas para o estado atual do projeto.

Sim e não. Deve estar relacionado à versão mais recente do software. No entanto, acho que a documentação é comparativamente baixa no projeto. Sei que estamos com falta de mão de obra, mas sem documentação os usuários têm mais problemas para ver como funciona a funcionalidade do software.
Portanto, prometo atualizar os documentos para a versão mais recente, mas mantendo, por exemplo, guias de migração de estados mais antigos, no entanto, estes são para versões muito desatualizadas por um bom tempo (talvez dividindo algumas das páginas para torná-las mais legíveis).

Espero conseguir alguma tração na comunidade (você pode rir do meu pensamento otimista) que nos ajude adicionando dicas e truques para configurar as coisas. Durante os últimos dias, quando trabalhei com as questões antigas, vi algumas boas ideias de membros da comunidade, que podem valer a pena mencionadas em uma página semelhante a um wiki.

Estou feliz de qualquer maneira .. mas ter um mantenedor seria uma boa ideia ... minha experiência é que essas coisas envelhecem rápido

Isso é verdade. Você quer dizer uma pessoa exclusivamente dedicada a manter a documentação atualizada?

Eu estaria bem em ajudar o projeto dessa forma também. Não me entenda mal: não estou pressionando para essa posição. Deve ser decidido de forma consensual.
No momento, não há muitas coisas novas para documentar. Principalmente atualizando o existente. Isso pode mudar se o projeto ganhar força novamente e um novo código for escrito / alterado. Então, o mantenedor da documentação depende do suporte dos desenvolvedores no sentido de que o gerente não é capaz de entender todos os detalhes técnicos.

Eu tenho um pouco mais de energia hoje, então aqui estão alguns pensamentos:

  • O wiki atual torna difícil para as pessoas contribuírem com documentação, já que tive que desabilitar o registro, exigindo que eu criasse usuários manualmente
  • O wiki integrado do GitHub torna a navegação difícil, especialmente se houver muitas páginas com links incorretos na página principal.
  • Deve ser fácil contribuir com documentação. De preferência, onde os usuários podem simplesmente clicar em um botão "Editar página" para editar o conteúdo existente e em um botão para criar um novo conteúdo. Um exemplo de que gosto pode ser encontrado aqui: http://marlinfw.org/docs/configuration/configuration.html - as alterações resultarão em uma solicitação pull para que possa ser revisada e devidamente vinculada por um mantenedor da documentação
  • No entanto, no exemplo anterior não há botão "Nova página", não tenho certeza de como isso poderia ser feito
  • O wiki atual torna difícil para as pessoas contribuírem com documentação, já que tive que desabilitar o registro, exigindo que eu criasse usuários manualmente

Isso é de alguma forma uma contradição para um wiki, mas eu entendo as necessidades.

  • O wiki integrado do GitHub torna a navegação difícil, especialmente se houver muitas páginas com links incorretos na página principal.

Isso é perfeitamente verdade. Não acho muito estético como o wiki é construído. É preciso ter certeza de que existe uma rede fina de links em todo o wiki para simplificar a navegação.

  • Deve ser fácil contribuir com documentação. De preferência, onde os usuários podem simplesmente clicar em um botão "Editar página" para editar o conteúdo existente e em um botão para criar um novo conteúdo. Um exemplo de que gosto pode ser encontrado aqui: http://marlinfw.org/docs/configuration/configuration.html - as alterações resultarão em uma solicitação pull para que possa ser revisada e devidamente vinculada por um mantenedor da documentação
  • No entanto, no exemplo anterior não há botão "Nova página", não tenho certeza de como isso poderia ser feito

Eles usam o recurso de páginas do github, mas em uma configuração mais elaborada do que a básica. Ainda não passei por tudo, mas posso olhar as coisas ...

Um usuário coleta informações ativamente em um WIKI local que é compartilhado em https://readthedocs.web.cern.ch/display/PARTK
Ele se ofereceu para transportar essas informações para um local diferente, mas a orientação da equipe do projeto é solicitada. O tópico para isso pode ser encontrado nos Grupos do Google PartKeepr https://groups.google.com/g/partkeepr-users/c/ehqapXqyY0o/m/1VWkA00dDAAJ

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

kgabryszewska picture kgabryszewska  ·  8Comentários

JoarGjersund picture JoarGjersund  ·  12Comentários

dani2bunny picture dani2bunny  ·  24Comentários

Drachenkaetzchen picture Drachenkaetzchen  ·  11Comentários

christianlupus picture christianlupus  ·  55Comentários