Wiki da Gesto Energia

→ O que é um wiki? ←

O Wiki (que estás neste momento a ler!) é um site de documentação interna. Foi criado para centralizar a documentação técnica da área de desenvolvimento de software e manutenção da infraestrutura web da Gesto.

Um wiki é um sistema de documentação genérica que pode servir qualquer fim. No caso da Gesto, uma vez que há uma grande quantidade de documentação no que diz respeito a desenvolvimento e configuração de software e infraestrutura, justifica-se a utilização de um repositório de informação em vez de documentos estáticos. À data da criação do wiki (junho de 2020) não se prevê que este wiki seja utilizado por outras áreas da empresa, embora nada o impeça.

A página de entrada Gesto Wiki dá uma visão geral das páginas e da sua lógica de organização. Não há um critério muito rígido sobre quando um tema deve estar contido apenas numa página, ou dividido por várias. Como regra genérica, deve usar-se o critério da quantidade de informação com que o utilizador é confrontado, que pode justrificar a desmultiplicação de um tema em várias páginas.

As alterações mais recentes podem ser consultadas em Recent Changes. As áreas temáticas dividem-se em namespaces (equivalentes a categorias), e todas as páginas do wiki estão listadas em Sitemap. Estes links estão sempre disponíveis na barra lateral à esquerda.

A filosofia de escrita num wiki é a de que o conteúdo tem prevalência sobre o estilo. É semelhante à forma de utilizar sistemas de preparação de documentos (como o LaTeX) em que se definem os conteúdos na escrita (com a devida hierarquização) e o sistema trata de gerar o estilo. Como tal, a escrita de documentos segue uma sintaxe determinada, e não usa formatação direta (por oposição a editores WYSIWYG).

A sinatxe completa pode ser consultada em Formatting Syntax.

À esquerda existe uma barra lateral com os principais links internos do Wiki, e à direita está a tabela de conteúdos da página atual, de acordo com os headings (cabeçalhos) e respetivos níveis definidos. A página atual oferece no topo quatro ícones, respetivamente, da esquerda para a direita:

1. Editar página atual (remete para caixa de edição)
2. Ver lista de versões anteriores da página
3. Ver lista de página que ligam à atual
4. Alterar o nome da página
5. Topo

O conteúdo principal está no corpo central da página, e a barra superior permite utilizar a pesquisa e aceder ao perfil de utilizador/configurações.

Este wiki é uma instalação do software open-source DokuWiki. Tem atualmente ativo o tema/template Argon, apesar de ter já outros temas também instalados.

Foi instalado, via cPanel/Softaculous, no alojamento web da Gesto. O subdomínio wiki.gestoenergy.com está apontado para a respetiva pasta de instalação: /home/gestoene/wiki.

O DokuWiki corre sobre PHP e tem como vantagens em relação a outros wikis:

• Instalação pequena (~20MB)
• utilização de ficheiros de texto em vez de bases de dados (simplicidade de configuração/migração)
• desenvolvimento ativo e comunidade grande

Apresenta como principal desvantagem:

• incompatibilidade da sintaxe com outros wikis, nomeadamente com MediaWiki (o wiki mais disseminado, utilizado pela Wikipédia). Existem contudo plugins/ferramentas que fazem esta conversão da sintaxe, caso se queira migrar para outro wiki.

Por exemplo para escrever texto com cor vermelha , estamos a utilizar um plugin DokuWiki chamado “color Plugin” que é necessário instalar à parte. Para tal:

• Seguir para a respectiva página (https://www.dokuwiki.org/plugin:color)
• Fazer “ Download” do ficheiro .zip
• Fazer “Upload” do .zip para a pasta de plugins no alojamento da página, isto, é no File Manager do CPanel ( wiki/lib/plugins/ )
• Fazer “Extract” do .zip e mudar o nome da pasta extraída para “color” (e apagar o .zip original).