WIKI Documentado de forma ágil.

Transcrição

1 WIKI Documentado de forma ágil. José Augusto (Guto)

2 Agenda Entendendo Wiki Sintaxe Estrutura Administração Controles de Acesso 46 Slides - 60 a 80 Minutos

3 Entendendo Wiki

4 Wiki: O que significa? Os termos wiki (pronunciado /uíqui/ ou /víqui/) e WikiWiki são utilizados para identificar um tipo específico de coleção de documentos em hipertexto ou o software colaborativo usado para criá-lo. O termo "Wiki wiki" significa "extremamente rápido" no idioma havaiano. Fonte:

5 Para o SysAdmin/DevOps qual parte da documentação é a mais importante?

6 Textos c/ Perfumarias? Formatação complexa? Design refinado? Formato fechado? Isso realmente importa?

7 Nada disso importa, o que importa é o conteúdo.

8 Necessidades do Sysadmin encontrar a informação de forma simples e rápida entender a informação para que ela lhe seja útil ter condições de modificar a informação com objetivo de complementar, atualizar ou corrigir. editar a informação de forma simples e rápida

9 Wiki: Características Acesso através de qualquer navegador/os Formatação do texto em linguagem MarkDown Edição coletiva/colaborativa (equipe) Rastreamento de mudanças (versionamento) Foco no conteúdo (editor sem distrações) Portabilidade do conteúdo (texto puro)

10 Wiki: Projetos conhecidos MediaWiki (site da wikipedia) Dokuwiki (site de documentação zabbix) MoinMoin (site de documentação projeto apache)

11 Wiki: Listagem de projetos No site wikimatrix.org você irá conhecer diversas ferramentas wiki, neste site você terá condições de avaliar os recursos e as principais diferenças entre estes sistemas. O site concentra informações referentes a grande maioria dos sistemas wiki open-source conhecidos hoje.

12 Nossa escolha: Dokuwiki

13

14 Dokuwiki: Características 1 Aplicação escrita em PHP Não usa banco de dados Velocidade no uso (por não usar banco de dados) Sintaxe de formatação simples (markdown) Suporte a plugins PHP (muitos plugins disponíveis) Suporte a categorização por namespaces

15 Dokuwiki: Características 2 Suporte a links interwikis (wikipedia/dokuwiki) Upload de imagens e uso de referências externas Buscas FullText Search com índices Interface Agradável com recursos Ajax Cache de Páginas Suporte a autenticação Local, LDAP, AD, MySQL e PostgreSQL

16 Dokuwiki: Características 3 Suporte a mais de 50 idiomas Código Fonte Aberto Processo de desenvolvimento bem documentado Syndication (RSS/ATOM) das mudanças recentes Outros... (

17 Dokuwiki: Diferencial O grande diferencial deste projeto é o fato de [não] utilizar base de dados relacional, tudo é salvo em arquivos no File System.

18 Dokuwiki: Diferencial O fato de não usar banco de dados, proporciona grande velocidade nas rotinas de criação, edição e leitura das páginas wiki, afinal, os dados são consumidos diretamente do filesystem, a aplicação faz a leitura de arquivos (.txt) em formato ASCII, algo simples, rápido, eficiente e universal.

19 Dokuwiki: Diferencial Backup simplificado, basta compactar o diretório do dokuwiki para termos todos os dados salvos. Além disto, cada página é um arquivo de texto (.txt) simples, ou seja, nem precisamos ter um servidor de aplicação instalado para ler os dados, qualquer editor de texto puro consegue ler os dados.

20 Sintaxe

21 Linaguagem Markdown MarkDown é uma linguagem de marcação simples, onde você declara a formatação desejada através de símbolos, estes símbolos orientam a conversão do texto puro para uma outra linguagem que normalmente é ((x)html). Referências: ia.org/wiki/markdown

22 ====== objetivo ======= descreva de forma objetiva, de preferência em uma linha o objetivo dessa wiki para agilizar o entendimento, exemplo: * descrever a instalação de ferramente XPTO no CentOS. ====== descrição ======= Nem sempre a descrição, mas dependendo do manual é bom investir algumas linhas contextualizando a necessidade, exemplo: * a instalacao da ferramenta XPTO foi uma demanda motivada pelo problema XPTO e após análise resolvemos abordar essa solução. ====== procedimento ======= ===== requisitos ===== pacotes/dependencias ===== instalação ===== instalando pacotes, tarballs, permissoes ===== configuração ===== configuracoes em arquivos, servicos, sub-sistemas e no própio aplicativo instalado. ===== operação ===== acesso ao aplicativo e como usar ====== referências ======= sites/links que lhe ajudaram a escrever esse documento, exemplo: * site 1 * site 2 * site 3

23

24 Mão na Massa entendendo na prática como criar e editar wikipages

25 Acessando wiki Para acesse a wiki entre em Clique em Entrar Utilize seu usuário Clique Dokuwiki (no topo superior direito) Clique em Playground

26 [[area:nome descrição]] [[playground:teste do guto Página teste do Guto]] criando página

27 //Itálico// sublinhado **negrito** <del> tachado <del> Formatação Simples

28 Lista não Lista ordenada ordenada - Alfredo * Alface * Tomate * Cebola * Alho - Bernardo - Camila - Daniel - Euclides dois espaços no inicio da linha antes do simbolo Listas

29 [[ Acesse o google]] [[wp > wiki]] [[infraestrutura:modelo de projeto Visualize o modelo de Projeto]] links

30 {{area:nome.png descricao caption}} {{url descricao caption}} {{wiki:fotoguto.png Foto do Gutocarvalho}} {{infraestrutura:racks.png Foto dos Racks do CPD}} {{ Logo do Detran}} Imagens

31 ^Nome^Telefone^ Jose Augusto Fernando Tabelas

32 Execute o comando (dois espaços) comando 1 comando 2 <code> conteúdo longo </code> Destacando Texto

33 <file php arquivo.php> <?php echo "hello world!";?> </file> Conteúdo Arquivo

34 Estrutura

35

36

37 Administração

38 Área administrativa

39 Gerenciamento de Plugins

40 Gerenciamento de Usuários

41 Controles de Acesso

42 Permissões Exemplo 1

43 Permissões Exemplo 2

44 Protegendo Páginas Wiki [[área:nome descrição]] [[infraestrutura:nome descrição]] [[infraestrutura:procedimentos:nome descrição]] [[infraestrutura:ambiente:nome descrição]] [[infraestrutura:processos:nome descrição]] [[desenvolvimento:nome descrição]] [[desenvolvimento:testes::nome descrição]] [[desenvolvimento:homologação::nome descrição]] [[playground:nome descrição]]

45 Perguntas? (5 min) José Augusto (Guto) Carvalho

46 Obrigado José Augusto (Guto) Carvalho