Sports

Processo de Produção. Processo de Produção. Ed. v1.0

Description
Processo de Produção i Processo de Produção Ed. v1.0 Processo de Produção ii Copyright 2013 UAB Você tem a liberdade de: Compartilhar copiar, distribuir e transmitir a obra. Remixar criar obras derivadas.
Categories
Published
of 55
All materials on our website are shared by users. If you have any questions about copyright issues, please report us to resolve them. We are always happy to assist you.
Related Documents
Share
Transcript
Processo de Produção i Processo de Produção Ed. v1.0 Processo de Produção ii Copyright 2013 UAB Você tem a liberdade de: Compartilhar copiar, distribuir e transmitir a obra. Remixar criar obras derivadas. Sob as seguintes condições: Atribuição Você deve creditar a obra da forma especificada pelo autor ou licenciante (mas não de maneira que sugira que estes concedem qualquer aval a você ou ao seu uso da obra). Uso não comercial Você não pode usar esta obra para fins comerciais. Compartilhamento pela mesma licença Se você alterar, transformar ou criar em cima desta obra, você poderá distribuir a obra resultante apenas sob a mesma licença, ou sob uma licença similar à presente. Para maiores informações consulte: Processo de Produção iii REVISION HISTORY NUMBER DATE DESCRIPTION NAME v1.0 Março 2013 Primeira versão do livro Eduardo de Santana Medeiros Alexandre Processo de Produção iv Sumário I O Processo de Produção 1 1 Visão Geral do Processo de Produção 3 2 Início rápido Vídeo demonstrando as instruções deste capítulo Acesse o repositório deste manual Gerando o PDF através do Servidor da Produção Explorando a estrutura de diretórios do projeto Realizando um fork no projeto Clonando o repositório do projeto Clonando através da linha de comando Clonando usando interface gráfico (no windows) Realizando alteração no projeto Comitando as alterações No linux Realize um push Gerando nova versão do livro com as alterações realizadas Realizando um pull-request Reportando sugestões, erros ou críticas Resumo técnico do processo Recapitulando Capacitação Marcando uma capacitação Instalar os softwares necessários no laboratório Coffee Break Auxiliares para o Ministrante Slides Processo de Produção v 4 Revisão de conteúdo anterior Benefícios desta etapa de revisão Escolhendo um conteúdo para revisar Realize um fork do projeto Clone o projeto Realize a sua contribuição Visualizando sua revisão Submetendo sua revisão Recapitulando Iniciando um livro Repositório do seu livro Estrutura inicial dos projetos Gere o pdf inicial do livro Atualize metadados do livro Visualize as alterações Configurando o livro e os capítulos Atualize o nome da disciplina Criando um novo capítulo Atualizando o conteúdo do novo capítulo Visão técnica Ferramentas utilizadas no processo Escrevendo o livro Iniciando um novo livro Gerando edição para impressão Revisando o livro Fechando versão para impressão Erratas dos livros Onde encontrar a errata Contribuindo com correções Contribuindo com indicações de erros Licença Escrevendo um livro Estrutura inicial do projeto Inserindo caracteres especiais no texto 40 Processo de Produção vi 9 Comunicações Capacitação Convite e Agendamento para a capacitação II Ferramentas utilizadas no Processo de Produção Instalação das Ferramentas Requisitos mínimos Criando conta de usuário no github Instalando git no Linux Instalando git(hub) no Windows Instalando git no Mac Configurando sua identidade Editor de texto no Linux Editor de texto no Windows Instalando ambiente para desenvolvimento off-line AsciiDoc cheatsheet Seções Parágrafos Blocos Text Macros: Referencias, images & include Código fonte de programas Trecho de código Listas Tabelas Matemática Comentários Desenhando gráficos Exemplos do graphviz Grafos Git Configurando o git com chave ssh Configurando o git com cor no linux Commit rápido Configurações avançadas Processo de Produção vii III Implementação do processo Criando um novo livro Baixando o projeto Criando a estrutura inicial do projeto Gerando um pdf do livro (off-line) Gerando o pdf do livro (off-line estilizado) Instalando ambiente para desenvolvimento off-line Instalando o git Instalando o mercurial Instalar o latex Instalar o asciidoc e dbaltex Removendo e atualizando o asciidoc e dbaltex Instala nova versão do dblatex Instala nova versão do asciidoc graphviz Instalando estilo do dblatex para geração do pdf estilizado Instalação dos scripts cgi IV Projetos e Pessoas Projetos de produção de livros Este manual Licenciatura em Computação a Distância - UFPB Período Período Período Período Período Período Período Período Pessoas Índice Remissivo 80 Processo de Produção 1 / 80 Parte I O Processo de Produção Processo de Produção 2 / 80 Nesta parte apresentamos o processo de produção de livros adotado pelo nosso curso. O primeiro capítulo apresenta rapidamente o processo geração dos livros a partir dos arquivos enviados para o Servidor de Produção. Em seguida, apresentamos uma visão geral do fluxo de trabalho da produção dos livros. Os capítulos seguintes apresentam detalhes sobre sobre o fluxo e as ferramentas utilizadas na produção. Processo de Produção 3 / 80 Capítulo 1 Visão Geral do Processo de Produção Este capítulo demonstra uma visão geral de um Processo de Produção de materiais didáticos proposto e adotado no Curso de Licenciatura em Computação a distância na Universidade Federal da Paraíba. A figura abaixo ilustra nosso processo de produção. Figura 1.1: Fluxo de trabalho, visão geral. A lista abaixo resume as etapas do processo: Processo seletivo de autores Nesta etapa a coordenação divulga um processo seletivo e os autores são selecionados conforme o edital. Capacitação A capacitação é iniciada com apresentação do processo, e as ferramentas necessárias. Em seguida, uma revisão inicia o autor no processo de produção. Ao final da capacitação, cada autor terá iniciado a produção de seu livro. Capacitação dos autores Os autores selecionados receberão capacitação sobre o processo e as ferramentas utilizadas na produção (ver Seção 6.1 [37]). Processo de Produção 4 / 80 Revisão de conteúdo Durante a capacitação, antes de iniciar a escrita, o novo autor é convidado a revisar um capítulo das disciplinas relacionadas, já escritas anteriormente. Esta revisão é uma etapa educativa e que possibilita: 1. Aprimorar os conteúdos já elaborados, contribuindo com sua qualidade; 2. Tornar o autor ciente de como os conteúdos foram apresentados para os alunos; 3. Integração entre os autores da mesma aŕea. 4. Introduzir, para o autor, as ferramentas necessárias para a produção; 5. Conscientizar o autor sobre os direitos autorais dos livros; Escrita Neste etapa o autor escreve os capítulos, elabora gráficos e está frequente enviando seu progresso. Envia conteúdo Este envio frequente possui várias utilizades: 1. Permite que os outros autores conheçam a estrutura do seu conteúdo e possam referenciar seu material; 2. Permite o editor intervenha na elaboração, seja realizando nova capacitação ou informando sobre conteúdos semelhantes já abordados nos outros livros. 3. Acompanhamento do progresso para verificar necessidade de ajuda na escrita (co-autores). 4. Possibilitar antecipar o trabalho do revisor. Quando os capítulos vão sendo finalizados, o revisor pode iniciar a revisão neles. 5. Garantir backup dos conteúdos escritos. Revisão do texto Quando um autor termina um capítulo, os revisores são acionados para realizarem as revisões no texto referido. Gerar edição Quando os autores e o revisor finalizam seus trabalhos, o editor gera versão para impressão. Contribuições para a Errata Depois do livro impresso, tanto os autores como os leitores podem contribuir para a construção da errata. Os leitores devem ser incentivados a enviarem correções dos erros encontrados nos livros. Manutenção da Errata Com base nas correções enviadas, o editor mantém uma errata do livro atualizada. O processo que propomos é assistido por diversas ferramentas. No próximo capítulo apresentaremos como utilizar as ferramentas necessárias para a produção dos livros. Processo de Produção 5 / 80 Capítulo 2 Início rápido OBJETIVOS DO CAPÍTULO Ao final deste capítulo você deverá ser capaz de: Gerar PDFs dos livros a partir de seus repositórios Realizar forks em projetos no github Clonar repositórios, baixando seus conteúdos para seu computador Realizar alterações nos capítulos dos livros Enviar alterações para o github Verificar as alterações realizadas no PDF gerado Submeter as alterações ao repositório pai, através de um Pull Request Submeter críticas e sugestões sobre um livro. Esta seção contém é um guia rápido para iniciar os autores/contribuidores no Processo de Produção. Nós iremos baixar o projeto deste manual, e editar o capítulo Capítulo 17 [79] incluindo nosso nome à lista de nomes contida no capítulo referido. As seções a seguir, ensinarão como realizar esta tarefa. Instalação do ambiente mínimo de produção Para você poder prosseguir com as instruções deste capítulo você deve primeiro instalar o ambiente mínimo de produção. Consulte as instruções de instalação em Seção 10.1 [44]. Não prossiga enquanto não possuir o ambiente instalado e configurado. 2.1 Vídeo demonstrando as instruções deste capítulo Para facilitar o entendimento deste capítulo, nós produzimos um vídeo demonstrando como realizar as instruções deste capítulo. O vídeo está disponível em: Dica Embora o livro demonstre como realizar o processo é importante ler este capítulo prestando bastante atenção em todas as informações. Processo de Produção 6 / Acesse o repositório deste manual Nota Um repositório é um local onde são armazenados os arquivos de um projeto, neste caso, todos os textos e imagens necessários para produzir este manual. Nossa primeira atividade será acessar o repositório deste manual que você está lendo: REPOSITÓRIO DESTE MANUAL NO GITHUB https://github.com/edusantana/producao-computacao-ead-ufpb. Figura 2.1: Página do repositório deste livro Dica Neste momento não é necessário explorar o repositório, basta saber que ele existe e que o texto que gera este manual está lá. Você utilizará o endereço deste repositório na próxima seção para gerar o pdf. 2.3 Gerando o PDF através do Servidor da Produção Nesta seção nós iremos aprender como gerar o PDF deste manual. A geração do PDF é através de uma operação no Servidor da Produção. Para gerar o PDF precisamos informar qual o repositório que contém o livro que desejamos gerar, neste caso, portanto, precisamos informar o endereço do repositório acessado na seção anterior. Processo de Produção 7 / 80 Importante Servidor da Produção Endereço da operação de geração de pdfs no servidor: github.html. Repositório deste manual É o mesmo endereço utilizado na seção anterior: producao-computacao-ead-ufpb https://github.com/edusantana/- Acesse o servidor da produção, informe o repositório deste manual e gere o pdf do livro (ver Figura 2.2 [7]). Figura 2.2: Geração do PDF através do Servidor da Produção Aguarde alguns instantes enquanto o PDF é gerado. Processo de Produção 8 / 80 Figura 2.3: Tela de geração do PDF Dica Matenha o hábito de verificar os logs gerados para certifica-se que não houve erros ou WAR- NINGs. Depois da geração do pdf: 1. Clique no último link, producao-computacao-ead-ufpb (no topo da página). 2. Clique no diretório livro 3. Clique em livro.pdf para baixar o livro gerado. Importante Caso não compreendeu como encontrar o PDf, consulte o vídeo (Seção 2.1 [5]) no início deste capítulo. Nota Pronto! Você conseguiu gerar o PDF através dos arquivos que estavam no servidor. O nosso trabalho consistirá em enviar nossas alterações para o servidor e verificar o resultado final a partir da geração do PDF. Na próxima seção iremos aprender a estrutura de diretórios dos projetos e o papel de alguns arquivos. Processo de Produção 9 / Explorando a estrutura de diretórios do projeto No github ou no servidor da produção, explore a estrutura do projeto. Estrura deste projeto -- cgi/ -- dblatex-computacao-ufpb/ -- estrutura-inicial/ livro/ -- capitulos/ code/ editoracao.asc -- graficos.asc -- inicio-rapido.asc pessoas.asc projetos.asc -- usuario.asc -- images/ slides/ livro.asc docinfo.xml slides.asc livro/ -- README.asciidoc 1 1 Estrutura padrão de novos projetos. 1 2 Todos os capítulos são criados neste diretório. 1 3 Os imagens códigos fontes dos exemplos são organizadas em subdiretórios deste diretório. 1 4 Arquivo fonte deste capítulo. 1 5 Capítulo que iremos editar mais adiante (Seção 2.7 [11]). 1 6 As imagens do livro são organizadas em subdiretórios deste diretório. 7 1, 10 1Necessários para criação dos slides. 1 8 Ponto de partida do livro. Onde todos os capítulos são incluídos. 1 9 Arquivo contendo alguns metadados, como os nomes dos autores. 2.5 Realizando um fork no projeto Nota Certifique-se que esteja logado no github com seu usuário antes de realizar o fork. Processo de Produção 10 / 80 Na página inicial do projeto, no github, clique em Fork para gerar um fork do projeto para você. O fork é necessário quando desejamos realizar alterações nos repositórios alheios. Dica A ajuda do github pode conter informações para auxiliar na realização do fork: https://help.github.com/articles/fork-a-repo. Quando você realiza um fork do repositório, o github irá criar um outro repositório onde somente você possui permissão de escrita. Diferença dos repositórios após o fork (read only) (depois do fork) 2.6 Clonando o repositório do projeto A operação de clone baixa todos os arquivos do projeto para o seu disco local. Como iremos realizar uma alteração no manual, precisaremos baixar os arquivos do projeto, clonando o fork Clonando através da linha de comando Em um diretório onde você deseja baixa o projeto, execute o seguinte comando: git clone https://github.com/seu-usuario/producao-computacao-ead-ufpb.git Cuidado Na operação de clone, o endereço clonado termina com.git Clonando usando interface gráfico (no windows) Importante O vídeo no início do capítulo (Seção 2.1 [5]) demonstra todas as etapas necessária no windows. Clique e arraste o endereço do repositório no github para o programa do github para o windows. Dica O ajuda do github pode lhe auxiliar nesta tarefa: Processo de Produção 11 / Realizando alteração no projeto Nota Neste momento, assumimos que você possui um editor de texto com highlight reconhecendo a linguagem asciidoc. Caso contrário, consulte Seção 10.1 [44] para efetuar a instalação. Após realizar o clone do projeto, encontre o arquivo livro/capitulos/pessoas.asc em seu computador. Abra-o para edição. Dica No windows, clique com o botão direito no repositório e escolha Open with Explorer para ir para o diretório onde o github salva os arquivos: Documentos\Github. Com o arquivo aberto, adicione o seu nome à lista. Por exemplo, adicionando Camyle:. Camyle de Araújo Silva -- *Revisora Ortográfica*, Comitando as alterações O git funciona com múltimos repositórios. Quando nós clonamos um projeto, nós envolvemos dois repositórios nesta operação: O repositório remoto O repositório local É o github. Onde os arquivos são salvos e disponibilizados para qualquer usuário com conexão a internet pode acessa-lo. Localizado em nosso computador. Mantém os arquivos orginais e todas as alterações que realizamos. Antes de submeter nossas alterações para o repositório remoto, precisamos primeiro submete-las para o repositório local. Esta operação é conhecida por Commit. Agora devemos submeter nossa alteração primeiro para o repositório local, realizando um commit No linux Execute o comando dentro de qualquer diretório do projeto: Ferramenta para realizar o commit gitg Marque os arquivos modificados (pessoas.asc) para stage, e adicione um comentário do commit, ex: Inclusão do nome Camyle . Processo de Produção 12 / 80 Figura 2.4: Commitando com o gitg no linux O próximo passo será submeter os nossos commits para o servidor remoto, através de uma operação chamada de push. 2.9 Realize um push Um push envia as alterações comitadas em seu repositório local para o servidor remoto (o github). Comando para realizar push no linux git push No github do windows, esta operação é conhecida por Sync Gerando nova versão do livro com as alterações realizadas Importante Percebam que qualquer alteração realizada foi feita no seu fork. Portanto, a geração do livro deverá ocorrer com o novo endereço. https://github.com/camyle/producao-computacao-ead-ufpb (seu fork ) https://github.com/edusantana/producao-computacao-ead-ufpb ( original) Re-execute a geração do livro (Seção 2.3 [6]) com o novo endereço do repositório forkado. Se você não lembra onde encontrar livro.pdf consulte Seção 2.3 [6]. Processo de Produção 13 / 80 Dica Caso sua alteração não apareça reveja suas ações: 1. Você realizou o commit com o arquivo modificado? 2. Você esqueceu de realizar o git push? 3. Você lembrou de informar o novo endereço contendo o nome do seu usuário? 4. Os logs da geração informou algum erro? 5. Seu navegador está retornando uma versão antiga do cache? Clique em atualizar! 2.11 Realizando um pull-request Agora que verificou que sua alteração foi inserida com sucesso, é o momento de enviar as alterações para o projeto original. Clique em Pull Request, no github, para enviar as alterações para o projeto original. As alterações enviadas não são incorporadas imediatamante, elas ficam em suspenso até que o responsável pelo repositório (o Editor) aceite o Pull Request Reportando sugestões, erros ou críticas Em qualquer momento da produção do livro, qualquer usuário pode submeter sugestões, erros ou críticas. O github possui um sistema de gerenciamento de erros/tarefas (issue tracking) onde os usuários podem submetê-los. Importante Adicione uma crítica no issue tracking deste manual! Acesse https://github.com/edusantana/- producao-computacao-ead-ufpb. Clique em Issues, em seguida em New Issue (Figura 2.5 [13]). Escreva a sua crítica e clique em Submit new Issue. Figura 2.5: Sistema de gerenciamento de erros do github Processo de Produção 14 / 80 Dica É importante isentivar os leitores a submeter críticas para que os livros estejam sempre sendo aprimorados Resumo técnico do processo O processo técnico está ilustrado em Figura 2.6 [14] e pode ser resumido em: 1. Realiza fork 2. Gera PDF 3. Realiza alterações 4. Commita e Sincroniza (push) 5. Gera PDF com as alterações 6. Realiza um Pull Request Figura 2.6: Resumo técnico do fluxo de trabalho 2.14 Recapitulando Este capitulo apresentou, de forma rápida, como funciona o processo de produção descrito neste manual. Nos próximos capítulos iremos descrever com mais detalhes cada uma das partes do Processo de Produção. Processo de Produção 15 / 80 Capítulo 3 Capacitação Na seção anterior (Capítulo 2 [5]) foi informado que os autores dos livro iriam receber uma capacitação antes de iniciar a produzir os livros. Este capítulo matém informações sobre esta etapa. 3.1 Marcando uma capacitação Antes de marcar uma capacitação talvez será necessário consultar os autores (também chamados de professores conteudistas) para agendar um dia em que a maioria possa participar. Com a data marcada, reserve um laboratório que comporte o público esperado. Estenda o convite aos professores que não são conteudistas, a tutores que também possam estar interessados. Pois embora o público álvo seja os conteudistas, as outras pessoas podem aprender o Processo de Produção e contribuir com melhorias nos materiais produzidos. Preparamos uma recomendação de texto (Seção [41]) que pode ser enviada por aos participantes da capacitação. O texto tem o propósito de agendar a reunião, e conter intruções que os professores podem realizar para se preparar para a reunião. 3.2 Instalar os softwares necessários no laboratório Certifique-se de que os computadores possuem as ferramentas mínimas necessárias (Seção 10.1 [44]) para a produção dos materiais. Lembre-se que as vezes os computadores não possuem permissão para instalar aplicativos, sendo necessário contactar os responsáveis antecipadamente. 3.3 Coffee Break A capacitação terá Coffee Break? Caso a reunião tenha Coffee Break, organize-se para providenciar a compra e a entrega no horário e local da capacitação. Lista de perguntas a se fazer: Processo de Produção 16 / 80 O ambiente possui mesa para servir? Quem irá levar os copos descartáveis? 3.4 Auxiliares para o Ministrante Durante uma capacitação é muito importante contar com a presença de outras pessoas, que tenham conhecimentos técnicos de informática, para auxili
We Need Your Support
Thank you for visiting our website and your interest in our free products and services. We are nonprofit website to share and download documents. To the running of this website, we need your help to support us.

Thanks to everyone for your continued support.

No, Thanks