Documenta

O Documenta é uma aplicação web para ajudar os membros do lab a documentar os seus projectos.

Princípios

  • A Experiência do utilizador vem em primeiro lugar VS
  • Simplificar (remover os atritos existentes no processo de documentação de projectos)
  • Desenvolvimento agil (pôr o serviço a funcionar rapidamente e iterar a partir daí)
  • Centrado nos documentos (a base do sistema são pastas de documentos de texto e ficheiros com media)

Aplicações semelhantes

Implementação actual

  • Owncloud (gestão de ficheiros, API WebDAV)
  • OC WordPress user db sharing app
  • OC Markdown editor app
  • Phile CMS (web publishing)

TODO:

  • Decidir o que vai aparecer na front page
  • Criar uma serie de commented template ".md" para colocar na skeleton folder para consumo dos novos users
    • User index.md Page
    • User page.md Who Am I
    • Pasta projectos
      • index.md Pasta projectos
      • Sub Pasta myfirstproject
        • index.md MyFirstProject
        • Sub Pasta MyFirstSession
          • index.md MyFirstSession
          • index.md MyFirstImageSession
        • Sub Pasta MyFirstImgSession
          • index.md MyFirstImageSession
  • Reparar os bugs existentes no theme
    • Reduzir o tamanho do tema
  • Colocar a source actualizada no Github

  • Acrescentar alguns plug-ins uteis:

  • Criar templates adicionais:

    • apresentar todas as imagens
  • Atualização do owncloud
  • Implementar Sistema estável de controlo de versõesVS

Feature Requests:

  • Markdown Cheat Sheet
  • Implementação do markdown em falta do original para o Striketrough ~~striked~~VS
  • Tutorial de utilização do sistema
  • Dockerfile para testes/desenvolvimento
  • Auto-indexing
  • Templates básicos (página de membro, página de projecto, etc)
  • Suporte para comentários nas páginas
  • Suporte para mostrar metadata sobre os utilizadores nas páginas (interesses, badges, etc.)
  • Aviso de actualizações de pagina por Subscrição RSS?VS
  • Detecção de Broken Links e envio de email para o colectivoVS
  • Script independente só para membros que permita dar estrelas anotações e comments
  • Páginas privadas (só para membros do lab)

Questões:

Como habilitar o Documenta para trabalho colaborativo?

PA: a solução mais fácil é utilizar a area partilhada. Uma solução mais complexa é ultilizar um sistema de controlo de versões como o git como backend em vez de utilizar apenas o sistema de ficheiros

VS: Usar o sistema integrado do onwcloud

VS: Integrar o OC com o GDrive (how to)[https://doc.owncloud.org/server/6.0/user_manual/external_storage/google_drive.html]

Mantém-se a integração com os utilizadores do WP ou adopta-se sistema independente

PA: Acho que se devia usar um sistema independente que no futuro ficasse integrado com as restantes apps do lab

Como evitar a utilização abusiva do espaço em disco no servidor? (upload de imagens gigantescas ainda é possível)

PA: podem-se estabelecer limites de upload máximo por ficheiro na configuração do Apache/PHP ou então quotas máximas de upload de ficheiros por utilizador _

Recursos uteis: