Commit 63ae2bdee38f47750e8204c8a8bfbee96e7141c5
1 parent
1ba4e300
Exists in
master
Primeira versão do Manual
Showing
50 changed files
with
249 additions
and
183 deletions
Show diff stats
Makefile
| ... | ... | @@ -6,7 +6,7 @@ LATEX = pdflatex |
| 6 | 6 | VERSION = 0.1.0 |
| 7 | 7 | |
| 8 | 8 | FIXOS_DIR = fixos |
| 9 | -FIXOS_SOURCES = informacoes.tex novosComandos.tex fichaCatalografica.tex \ | |
| 9 | +FIXOS_SOURCES = informacoes.tex novosComandos.tex \ | |
| 10 | 10 | pacotes.tex comandos.tex setup.tex \ |
| 11 | 11 | listasAutomaticas.tex indiceAutomatico.tex |
| 12 | 12 | |
| ... | ... | @@ -14,8 +14,7 @@ FIXOS_FILES = $(addprefix $(FIXOS_DIR)/, $(FIXOS_SOURCES)) |
| 14 | 14 | |
| 15 | 15 | EDITAVEIS_DIR = editaveis |
| 16 | 16 | EDITAVEIS_SOURCES = resumo.tex \ |
| 17 | - abreviaturas.tex \ | |
| 18 | - apendices.tex anexos.tex | |
| 17 | + abreviaturas.tex | |
| 19 | 18 | |
| 20 | 19 | EDITAVEIS_FILES = $(addprefix $(EDITAVEIS_DIR)/, $(EDITAVEIS_SOURCES)) |
| 21 | 20 | ... | ... |
capitulos/32-noosfero-conteudos.tex
| ... | ... | @@ -40,12 +40,12 @@ Nas seções abaixo, serão apresentados alguns dos conteúdos que o Noosfero of |
| 40 | 40 | |
| 41 | 41 | Um artigo no Noosfero é a página/conteúdo que contém todo o conteúdo escrito de outros conteúdos no Noosfero, seja ele um Blog ou Fórum, por exemplo. Através da do artigo, o usuário pode disponibilizar um texto para ser publicado em seu blog de notícias ou mesmo em um link no bloco lateral da comunidade. |
| 42 | 42 | |
| 43 | -Para incluir um artigo (páginas) basta selecionar a opção \includegraphics[width=2.4cm]{figuras/artigo_texto.png} (Artigo de texto com editor visual). Quando esse artigo é selecionado, é necessário preencher as informações do artigo, assim como o corpo da mensagem, como apresentado na Figura \ref{fig:cadastro_artigo}. Também é possível a criação de artigos usando as linguagens de marcações HTML ou Textile (deficiente visual). | |
| 43 | +Para incluir um artigo (páginas) basta selecionar a opção \includegraphics[width=4cm]{figuras/artigo_texto.png} (Artigo de texto com editor visual). Quando esse artigo é selecionado, é necessário preencher as informações do artigo, assim como o corpo da mensagem, como apresentado na Figura \ref{fig:cadastro_artigo}. Também é possível a criação de artigos usando as linguagens de marcações HTML ou Textile (deficiente visual). | |
| 44 | 44 | |
| 45 | 45 | \graphicspath{{figuras/}} |
| 46 | 46 | \begin{figure}[H] |
| 47 | 47 | \centering |
| 48 | - \includegraphics[width=.6\textwidth]{cadastro_artigo.png} | |
| 48 | + \includegraphics[width=1\textwidth]{cadastro_artigo.png} | |
| 49 | 49 | \caption{Cadastro das informações do artigo} |
| 50 | 50 | \label{fig:cadastro_artigo} |
| 51 | 51 | \end{figure} |
| ... | ... | @@ -56,10 +56,10 @@ Quando selecionada a opção de um artigo utilizando o editor visual, é possív |
| 56 | 56 | |
| 57 | 57 | O Noosfero também fornece a possibilidade de manter um blog de notícias. Através do blog, é possível manter as principais informações e notícias de uma determinada comunidade, pessoa ou software. Como exemplo, você pode criar uma notícia para divulgar uma nova versão do seu software. |
| 58 | 58 | |
| 59 | -Todo software criado, já possui uma área própria de notícias. Ela pode ser acessada em: | |
| 59 | +Todo software criado, já possui uma área própria de notícias por padrão. Ela pode ser acessada em: | |
| 60 | 60 | |
| 61 | 61 | \begin{lstlisting}[basicstyle=\small] |
| 62 | -https://portal.softwarepublico.gov.br/social/profile/[nomedosoftware]/blog | |
| 62 | +https://softwarepublico.gov.br/social/profile/[nomedosoftware]/blog | |
| 63 | 63 | \end{lstlisting} |
| 64 | 64 | |
| 65 | 65 | Você pode acessá-la no bloco lateral direito da página de software, na opção Notícias, conforme mostrado pela Figura \ref{fig:bloco_participee}. |
| ... | ... | @@ -67,14 +67,14 @@ Você pode acessá-la no bloco lateral direito da página de software, na opçã |
| 67 | 67 | \graphicspath{{figuras/}} |
| 68 | 68 | \begin{figure}[H] |
| 69 | 69 | \centering |
| 70 | - \includegraphics[width=.6\textwidth]{bloco_participe.png} | |
| 70 | + \includegraphics[width=.25\textwidth]{bloco_participe.png} | |
| 71 | 71 | \caption{Bloco de participação com o acesso ao blog de notícias.} |
| 72 | 72 | \label{fig:bloco_participee} |
| 73 | 73 | \end{figure} |
| 74 | 74 | |
| 75 | 75 | É possivel a criação de novos posts, clonar posts ou configurar posts existentes. Cada post corresponde a uma notícia. |
| 76 | 76 | |
| 77 | -Para incluir outros blogs é necessário Incluir outros conteúdos e selecionar a opção \includegraphics[width=2.4cm]{figuras/conteudo_blog.png} preenchendo as informações da tela disponível na Figura X. | |
| 77 | +Para incluir outros blogs é necessário Incluir outros conteúdos e selecionar a opção \includegraphics[width=4.4cm]{figuras/conteudo_blog.png} (blog) preenchendo as informações da tela disponível na Figura \ref{fig:tela_blog}. | |
| 78 | 78 | |
| 79 | 79 | \graphicspath{{figuras/}} |
| 80 | 80 | \begin{figure}[H] |
| ... | ... | @@ -89,17 +89,17 @@ Para incluir outros blogs é necessário Incluir outros conteúdos e selecionar |
| 89 | 89 | O Noosfero possui suporte para criação de eventos, que são utilizadas para divulgação de alguma data importante sobre o projeto. Seu funcionamento é semelhante aos eventos de e-mail do Gmail, Outlook ou Facebook. É possível criar um evento em |
| 90 | 90 | uma determinada data e hora e divulgá-lo para os membros da comunidade. |
| 91 | 91 | |
| 92 | -Para incluir um evento basta selecionar a opção \includegraphics[width=2.4cm]{figuras/botao_evento.png} de acordo com o demonstrado em Incluir outros conteúdos e preencher as informações do evento, conforme imagem ilustrada pela Figura \ref{fig:tela_eventos}. | |
| 92 | +Para incluir um evento basta selecionar a opção \includegraphics[width=3.4cm]{figuras/botao_evento.png} (Evento) de acordo com o demonstrado em Incluir outros conteúdos e preencher as informações do evento, conforme imagem ilustrada pela Figura \ref{fig:tela_eventos}. | |
| 93 | 93 | |
| 94 | 94 | \graphicspath{{figuras/}} |
| 95 | 95 | \begin{figure}[H] |
| 96 | 96 | \centering |
| 97 | - \includegraphics[width=.6\textwidth]{tela_eventos.png} | |
| 97 | + \includegraphics[width=1\textwidth]{cadastro_eventos.png} | |
| 98 | 98 | \caption{Tela com informações para criação de eventos.} |
| 99 | 99 | \label{fig:tela_eventos} |
| 100 | 100 | \end{figure} |
| 101 | 101 | |
| 102 | -Após a criação do evento, pode ser feito uma alteração nos blocos laterais para que ele seja visualizado pelos usuários e membros da plataforma. Para isso, deve selecionar a opção \includegraphics[width=2.4cm]{figuras/opcaobloco_evento.png} nos blocos laterais. | |
| 102 | +Após a criação do evento, pode ser feito uma alteração nos blocos laterais para que ele seja visualizado pelos usuários e membros da plataforma. Para isso, deve selecionar a opção \includegraphics[width=4.7cm]{figuras/opcaobloco_evento.png} (Eventos da comunidades do software) nos blocos laterais. | |
| 103 | 103 | |
| 104 | 104 | Se o bloco foi adicionado corretamente, ele deve aparecer na comunidade do software, conforme visto na Figura \ref{fig:bloco_eventos}. |
| 105 | 105 | |
| ... | ... | @@ -119,7 +119,7 @@ O Noosfero permite a criação de Pastas, que possuem o mesmo esquema das pastas |
| 119 | 119 | O código fonte é recomendado que seja guardado no repositório, explicado no capítulo \ref{cap:gitlab}). |
| 120 | 120 | \end{tcolorbox} |
| 121 | 121 | |
| 122 | -Para criação de uma Pasta basta selecionar a opção \includegraphics[width=2.4cm]{figuras/botao_pasta.png}, como demonstrado na Figura \ref{fig:tela_pasta}. O usuário deve inserir o nome da pasta desejada, a licença aplicada, alguma descrição relevante para a pasta, categorias que podem ajudar na busca além da visibilidade. | |
| 122 | +Para criação de uma pasta basta selecionar a opção \includegraphics[width=4.4cm]{figuras/botao_pasta.png} (Pasta), como demonstrado na Figura \ref{fig:tela_pasta}. O usuário deve inserir o nome da pasta desejada, a licença aplicada, alguma descrição relevante para a pasta, categorias que podem ajudar na busca além da visibilidade. | |
| 123 | 123 | |
| 124 | 124 | \graphicspath{{figuras/}} |
| 125 | 125 | \begin{figure}[H] |
| ... | ... | @@ -129,7 +129,7 @@ Para criação de uma Pasta basta selecionar a opção \includegraphics[width=2. |
| 129 | 129 | \label{fig:tela_pasta} |
| 130 | 130 | \end{figure} |
| 131 | 131 | |
| 132 | -Para a inclusão de arquivos, o usuário deve acessar a opção \includegraphics[width=2.4cm]{figuras/botao_arquivoenv.png}. Essa opção permite que o usuário envie qualquer arquivo da máquina diretamente para o SPB (Noosfero), a Figura \ref{fig:tela_arquivoenv} ilustra a tela de upload de arquivos. Nessa tela o usuário deve apenas selecionar o arquivo dentro da máquina. | |
| 132 | +Já na inclusão de arquivos, o usuário deve acessar a opção \includegraphics[width=4.4cm]{figuras/botao_arquivoenv.png} (Arquivo enviado). Essa opção permite que o usuário envie qualquer arquivo da máquina diretamente para o SPB (Noosfero), a Figura \ref{fig:tela_arquivoenv} ilustra a tela de upload de arquivos. Nessa tela o usuário deve apenas selecionar o arquivo dentro da máquina. | |
| 133 | 133 | |
| 134 | 134 | \graphicspath{{figuras/}} |
| 135 | 135 | \begin{figure}[H] |
| ... | ... | @@ -143,7 +143,7 @@ Para a inclusão de arquivos, o usuário deve acessar a opção \includegraphics |
| 143 | 143 | |
| 144 | 144 | O conteúdo Fórum, permite a criação de tópicos de discussões e debates entre os usuários sobre uma determinada questão sobre o software ou comunidade\footnote{Maiores informações: https://pt.wikipedia.org/wiki/F\%C3\%B3rum\_de\_discuss\%C3\%A3o}. |
| 145 | 145 | |
| 146 | -Para incluir um fórum basta selecionar a opção \includegraphics[width=2.4cm]{figuras/tela_forum.png} (Fórum). Logo após, a tela mostrada pela Figura \ref{fig:tela_forum} será mostrada. Nessa tela o usuário deve informar o nome do fórum, descrição, licença, posts por página e termo de uso. | |
| 146 | +Para incluir um fórum basta selecionar a opção \includegraphics[width=4.4cm]{figuras/botao_forum.png} (Fórum). Logo após, a tela mostrada pela Figura \ref{fig:tela_forum} será mostrada. Nessa tela o usuário deve informar o nome do fórum, descrição, licença, posts por página e termo de uso. | |
| 147 | 147 | |
| 148 | 148 | \graphicspath{{figuras/}} |
| 149 | 149 | \begin{figure}[H] | ... | ... |
capitulos/33-noosfero-software.tex
| ... | ... | @@ -60,7 +60,7 @@ A página de software contém o resumo de informações do software, para que os |
| 60 | 60 | Na \hyperref[sub:localizando_soft]{página de localização dos softwares}, existem diversas categorias que auxiliam o usuário a localizar o(s) software(s) mais rapidamente, conforme ilustrado pela Figura \ref{fig:pagina_exemplo}. Essas categorias podem ser editadas, caso seja de interesse do coordenador. |
| 61 | 61 | |
| 62 | 62 | \graphicspath{{figuras/}} |
| 63 | -\begin{figure}[htb!] | |
| 63 | +\begin{figure}[H] | |
| 64 | 64 | \centering |
| 65 | 65 | \includegraphics[width=0.95\textwidth]{filtro_software.png} |
| 66 | 66 | \caption{Busca de softwares por categorias.} |
| ... | ... | @@ -70,9 +70,9 @@ Na \hyperref[sub:localizando_soft]{página de localização dos softwares}, exis |
| 70 | 70 | Para editar as categorias de um software, o coordenador deve acessar \hyperref[sub:painel_controle]{o painel de controle} do software. Após isso, ele deve clicar na opção \includegraphics[width=3.2cm]{figuras/infoconf_comunidade.png}(informações e configurações da comunidade). Na tela disponibilizada pela Figura \ref{fig:categorias_software}, é possível observar uma opção para Categorizar o Software. É possível associar o software a uma ou mais categorias. |
| 71 | 71 | |
| 72 | 72 | \graphicspath{{figuras/}} |
| 73 | -\begin{figure}[htb!] | |
| 73 | +\begin{figure}[H] | |
| 74 | 74 | \centering |
| 75 | - \includegraphics[width=0.5\textwidth]{categorias_software} | |
| 75 | + \includegraphics[width=0.55\textwidth]{categorias_software} | |
| 76 | 76 | \caption{Categorias de um software.} |
| 77 | 77 | \label{fig:categorias_software} |
| 78 | 78 | \end{figure} |
| ... | ... | @@ -96,7 +96,7 @@ Há também outros dados adicionais que não são obrigatórios, como por exempl |
| 96 | 96 | \graphicspath{{figuras/}} |
| 97 | 97 | \begin{figure}[htb!] |
| 98 | 98 | \centering |
| 99 | - \includegraphics[width=0.8\textwidth]{relato_uso.png} | |
| 99 | + \includegraphics[width=0.65\textwidth]{relato_uso.png} | |
| 100 | 100 | \caption{Tela para cadastro de um relato de uso no software.} |
| 101 | 101 | \label{fig:relato_uso} |
| 102 | 102 | \end{figure} |
| ... | ... | @@ -130,12 +130,12 @@ Para acesso ao painel de controle do software é utilizado o mesmo procedimento |
| 130 | 130 | |
| 131 | 131 | No painel de controle da página de software, é possível o coordenador alterar as principais informações sobre o software (plataformas, descrição, características, link de demonstração, sistemas operacionais suportados, dentre outras informações) |
| 132 | 132 | |
| 133 | -Para acessar o painel de controle basta clicar na opção \includegraphics[width=2.4cm]{figuras/botao_infosoftware.png} (Informação de Software). Após acessar essa opção, a tela mostrada pela Figura \ref{fig:alteracoes_software} será disponibilizada. Esta tela possui duas abas, sendo a primeira aba destinada a informações mais básicas, e a segunda aba sendo de informações mais técnicas. | |
| 133 | +Para acessar o painel de controle basta clicar na opção \includegraphics[width=4cm]{figuras/botao_infosoftware.png} (Informação de Software). Após acessar essa opção, a tela mostrada pela Figura \ref{fig:alteracoes_software} será disponibilizada. Esta tela possui duas abas, sendo a primeira aba destinada a informações mais básicas, e a segunda aba sendo de informações mais técnicas. | |
| 134 | 134 | |
| 135 | 135 | \graphicspath{{figuras/}} |
| 136 | 136 | \begin{figure}[htb!] |
| 137 | 137 | \centering |
| 138 | - \includegraphics[width=0.8\textwidth]{edicao_software.png} | |
| 138 | + \includegraphics[width=0.7\textwidth]{edicao_software.png} | |
| 139 | 139 | \caption{Tela para alterações no cadastro do software.} |
| 140 | 140 | \label{fig:alteracoes_software} |
| 141 | 141 | \end{figure} |
| ... | ... | @@ -145,20 +145,20 @@ Para acessar o painel de controle basta clicar na opção \includegraphics[width |
| 145 | 145 | \subsection{Alterando e Adicionando Links e Bloco do Software} |
| 146 | 146 | \label{sec:block_software} |
| 147 | 147 | |
| 148 | -É possível editar os hiperlinks e blocos existentes na página de um software. Para isso é necessário que o usuário seja administrador do software \hyperref[sub:painel_controle]{e acesse o Painel de Controle}. Com o painel de controle acessado, o usuário deve acessar a opção \includegraphics[width=3.2cm]{figuras/editar_blocos.png}(Editar blocos laterais). Na seção \ref{ref:blocos_laterais}, é apresentado um breve tutorial sobre a edição dos blocos laterais de uma comunidade, no entanto, o procedimento para software é o mesmo. | |
| 148 | +É possível editar os hiperlinks e blocos existentes na página de um software. Para isso é necessário que o usuário seja administrador do software \hyperref[sub:painel_controle]{e acesse o Painel de Controle}. Com o painel de controle acessado, o usuário deve acessar a opção \includegraphics[width=3.7cm]{figuras/editar_blocos.png}(Editar blocos laterais). Na seção \ref{ref:blocos_laterais}, é apresentado um breve tutorial sobre a edição dos blocos laterais de uma comunidade, no entanto, o procedimento para software é o mesmo. | |
| 149 | 149 | |
| 150 | 150 | \subsection{Disponibilizando uma nova versão de um software no Portal} |
| 151 | 151 | |
| 152 | 152 | Quando o software é disponibilizado e feito a revisão dos textos/blocos/links no software o último passo é disponibilizá-lo para download. Para isso o usuário deve acessar o seu painel de controle, acessar a opção "Gerenciar Conteúdo". |
| 153 | 153 | |
| 154 | -É recomendado que o usuário crie uma pasta para colocar as versões estáveis do software, que serão disponibilizadas para Download. Para isso o usuário deve acessar a opção \includegraphics[width=3.2cm]{figuras/novo_conteudo.png}(Novo conteúdo) e logo em seguida \href{sub:folder}{Pasta}. | |
| 154 | +É recomendado que o usuário crie uma pasta para colocar as versões estáveis do software, que serão disponibilizadas para Download. Para isso o usuário deve acessar a opção \includegraphics[width=2.8cm]{figuras/novo_conteudo.png}(Novo conteúdo) e logo em seguida \href{sub:folder}{Pasta}. | |
| 155 | 155 | |
| 156 | 156 | Logo depois de criar a pasta e subir os conteúdos relacionados ao software. Deve-se escolher a opção \href{sec:block_software}{editar blocos laterais} no painel de controle da página do Software. Para editar o bloco de downloads (Figura \ref{fig:bloco_downloads}), o usuário deve clicar no botão \includegraphics[width=.45cm]{editar.png}(editar) no bloco de download do software, onde será aberta uma popup, conforme é mostrado na Figura \ref{fig:bloco_estavel}. |
| 157 | 157 | |
| 158 | 158 | \graphicspath{{figuras/}} |
| 159 | 159 | \begin{figure}[htb!] |
| 160 | 160 | \centering |
| 161 | - \includegraphics[width=0.8\textwidth]{bloco_downloads.png} | |
| 161 | + \includegraphics[width=0.7\textwidth]{bloco_downloads.png} | |
| 162 | 162 | \caption{Bloco de download do software.} |
| 163 | 163 | \label{fig:bloco_downloads}. |
| 164 | 164 | \end{figure} |
| ... | ... | @@ -166,7 +166,7 @@ Logo depois de criar a pasta e subir os conteúdos relacionados ao software. Dev |
| 166 | 166 | \graphicspath{{figuras/}} |
| 167 | 167 | \begin{figure}[htb!] |
| 168 | 168 | \centering |
| 169 | - \includegraphics[width=0.8\textwidth]{bloco_estavel.png} | |
| 169 | + \includegraphics[width=0.38\textwidth]{bloco_estavel.png} | |
| 170 | 170 | \caption{Tela de alteração do bloco de downloads do software.} |
| 171 | 171 | \label{fig:bloco_estavel}. |
| 172 | 172 | \end{figure} | ... | ... |
capitulos/5-gitlab.tex
| ... | ... | @@ -26,7 +26,7 @@ Atualmente existe uma versão do Gitlab no novo portal do Software Público, que |
| 26 | 26 | \section{Trabalhando com o Gitlab} |
| 27 | 27 | \subsection{Configuração do Gitlab} |
| 28 | 28 | |
| 29 | -O Gitlab utiliza a chave pública SSH da máquina para realizar a autenticação sem a necessidade da utilização de senhas. Através da configuração dessa chave é possível utilizar todas as funções que o Gitlab oferece, para realizar a configuração basta: | |
| 29 | +O Gitlab utiliza a chave pública SSH da máquina para realizar a autenticação sem a necessidade da utilização de senhas. Através da configuração dessa chave é possível utilizar todas as funções que o Gitlab oferece, para realizar a configuração deve: | |
| 30 | 30 | |
| 31 | 31 | \begin{itemize} |
| 32 | 32 | \item Gerar a chave SSH pública e colocá-la no Gitlab. |
| ... | ... | @@ -38,26 +38,39 @@ Para gerar a chave pública SSH, existe um tutorial disponível no site oficial |
| 38 | 38 | \begin{itemize} |
| 39 | 39 | \item Git: \url{https://git-scm.com/book/pt-br/v1/Git-no-Servidor-Gerando-Sua-Chave-P\%C3\%BAblica-SSH}; |
| 40 | 40 | \item SPB: \url{https://softwarepublico.gov.br/social/spb/como-faco-pra-utilizar-o-ambiente-colaborativo} |
| 41 | - | |
| 42 | 41 | \end{itemize} |
| 43 | 42 | |
| 44 | -Logo após gerar essa chave pública, o usuário deve adicioná-la no Gitlab do novo Software Público Brasileiro. Para isso o usuário deve: | |
| 45 | - | |
| 46 | - \begin{itemize} | |
| 47 | - \item Logar no portal SPB; | |
| 48 | - \end{itemize} | |
| 49 | - | |
| 50 | -Em seguida, o usuário deve acessar o Menu superior > Desenvolvimento > Perfil. A tela ilustrada pela Figura X será apresentada. | |
| 51 | - | |
| 52 | -IMAGEM | |
| 53 | - | |
| 54 | -Logo após o usuário, deve selecionar a opção "SSH Keys" no menu superior, de acordo com a Figura X. | |
| 55 | - | |
| 56 | -IMAGEM | |
| 57 | - | |
| 58 | -Depois de selecionar a opção "SSH Keys", o usuário vera a tela ilustrada pela Figura X. Nessa tela possui todos as chaves SSH cadastradas pelos usuários, isto é, cada chave pode ou não representar cada computador utilizado pelo desenvolvedor. Para adicionar uma nova chave, o usuário deve clicar na opção "Add SSH Key". | |
| 59 | - | |
| 60 | -IMAGEM | |
| 43 | +Logo após gerar essa chave pública, o usuário deve adicioná-la no Gitlab do novo Software Público Brasileiro. Para isso o usuário deve logar no portal SPB. | |
| 44 | + | |
| 45 | +Em seguida, o usuário deve acessar o Menu superior > Desenvolvimento > Perfil. A tela ilustrada pela Figura \ref{fig:perfil_gitlab} será apresentada. Nessa tela, é possível alterar todas as informações relativas ao ambiente do gitlab, inclusive nome, avatar, skype, linkedin, entre outros. | |
| 46 | + | |
| 47 | +\graphicspath{{figuras/}} | |
| 48 | +\begin{figure}[H] | |
| 49 | + \centering | |
| 50 | + \includegraphics[width=.95\textwidth]{perfil_gitlab.png} | |
| 51 | + \caption{Tela de alteração do perfil do gitlab.} | |
| 52 | + \label{fig:perfil_gitlab} | |
| 53 | +\end{figure} | |
| 54 | + | |
| 55 | +Logo após o usuário, deve selecionar a opção "SSH Keys" no menu superior, de acordo com a Figura \ref{fig:menusup_gitlab}. | |
| 56 | + | |
| 57 | +\graphicspath{{figuras/}} | |
| 58 | +\begin{figure}[H] | |
| 59 | + \centering | |
| 60 | + \includegraphics[width=.95\textwidth]{menusup_gitlab.png} | |
| 61 | + \caption{Menu superior do gitlab com a opção "SSH keys" logo a direita.} | |
| 62 | + \label{fig:menusup_gitlab} | |
| 63 | +\end{figure} | |
| 64 | + | |
| 65 | +Depois de selecionar a opção "SSH Keys", o usuário vera a tela ilustrada pela Figura X. Nessa tela possui todos as chaves SSH cadastradas pelos usuários, isto é, cada chave pode ou não representar cada computador utilizado pelo desenvolvedor. Para adicionar uma nova chave, o usuário deve clicar na opção \includegraphics[width=2.2cm]{figuras/botao_sshkeys.png}(Add SSH Key). | |
| 66 | + | |
| 67 | +\graphicspath{{figuras/}} | |
| 68 | +\begin{figure}[H] | |
| 69 | + \centering | |
| 70 | + \includegraphics[width=.75\textwidth]{tela_sshkeys.png} | |
| 71 | + \caption{Menu superior do gitlab com a opção "SSH keys" logo a direita.} | |
| 72 | + \label{fig:menusup_gitlab} | |
| 73 | +\end{figure} | |
| 61 | 74 | |
| 62 | 75 | No momento de adição da chave SSH, o usuário deve preencher um formulário com 2 (dois) campos, que contém: |
| 63 | 76 | \begin{itemize} |
| ... | ... | @@ -65,7 +78,7 @@ No momento de adição da chave SSH, o usuário deve preencher um formulário co |
| 65 | 78 | \item \textbf{Key} - Campo da Chave SSH gerada e que deve ser copiada para o campo. |
| 66 | 79 | \end{itemize} |
| 67 | 80 | |
| 68 | -Após isso, será necessário somente a configuração do Git no ambiente de desenvolvimento do usuário, que será apresentada na seção /ref{cap:git}. | |
| 81 | +Após isso, será necessário somente a configuração do Git no ambiente de desenvolvimento do usuário, que será apresentada na seção \ref{cap:git} . | |
| 69 | 82 | |
| 70 | 83 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 71 | 84 | |
| ... | ... | @@ -78,27 +91,47 @@ No link \url{https://softwarepublico.gov.br/gitlab/explore/projects}, possui tod |
| 78 | 91 | \label{sub:gitlab_projeto} |
| 79 | 92 | \subsubsection{Criando um novo Projeto} |
| 80 | 93 | |
| 81 | -Caso esteja começando um novo projeto de software, é necessário que faça a criação de um novo projeto no Gitlab. Para realizar isso, o usuário deve acessar no menu superior a opção de "Desenvolvimento" e logo após "Novo Projeto", após isso, é apresentada a tela ilustrada pela Figura X. | |
| 94 | +Caso esteja começando um novo projeto de software, é necessário que faça a criação de um novo projeto no Gitlab. Para realizar isso, o usuário deve acessar no menu superior a opção de "Desenvolvimento" e logo após "Novo Projeto", após isso, é apresentada a tela ilustrada pela Figura \ref{fig:criacao_projeto}. | |
| 95 | + | |
| 96 | +\graphicspath{{figuras/}} | |
| 97 | +\begin{figure}[H] | |
| 98 | + \centering | |
| 99 | + \includegraphics[width=.85\textwidth]{criacao_projeto.png} | |
| 100 | + \caption{Tela de criação de projetos no Gitlab.} | |
| 101 | + \label{fig:criacao_projeto} | |
| 102 | +\end{figure} | |
| 82 | 103 | |
| 83 | 104 | Na tela da criação do projeto serão requisitados alguns dados como: |
| 84 | 105 | |
| 85 | 106 | \begin{itemize} |
| 86 | - \item Project Name: Nome do Software; | |
| 87 | - \item Namespace: Pessoa ou grupo que terá a permissão no projeto; | |
| 88 | - \item Description: Descrição sucinta e clara do Software; | |
| 89 | - \item Visibility: Privacidade do Projeto\footnote{O Gitlab permite que os projetos possam ser configurados de acordo com a necessidade do desenvolvedor} | |
| 107 | + \item \textbf{Project Name:} Nome do Software; | |
| 108 | + \item \textbf{Namespace:} Pessoa ou grupo que terá a permissão no projeto; | |
| 109 | + \item \textbf{Description:} Descrição sucinta e clara do Software; | |
| 110 | + \item \textbf{Visibility:} Privacidade do Projeto\footnote{O Gitlab permite que os projetos possam ser configurados de acordo com a necessidade do desenvolvedor} | |
| 90 | 111 | \begin{itemize} |
| 91 | - \item Private - O projeto só pode ser acessado pelos membros do mesmo. Além disso, ele fica oculto para todos os usuários. | |
| 92 | - \item Internal - O projeto fica aberto para os usuários, no entanto, só podem ser clonado apenas por usuários logados. | |
| 93 | - \item Public - Qualquer usuário independente de estar logado, consegue visualizar e clonar o projeto. | |
| 112 | + \item \textbf{Private} - O projeto só pode ser acessado pelos membros do mesmo. Além disso, ele fica oculto para todos os usuários. | |
| 113 | + \item \textbf{Internal} - O projeto fica aberto para os usuários, no entanto, só podem ser clonado apenas por usuários logados. | |
| 114 | + \item \textbf{Public} - Qualquer usuário independente de estar logado, consegue visualizar e clonar o projeto. | |
| 94 | 115 | \end{itemize} |
| 95 | 116 | \end{itemize} |
| 96 | 117 | |
| 118 | + | |
| 119 | +\begin{tcolorbox}[colback=red!5,colframe=red!40!black,title=\textbf{Observação}] | |
| 120 | +Para acessar o projeto criado, além de outros projetos e/ou grupos que o usuário faça parte, deve acessar o seguinte endereço: | |
| 121 | +https://softwarepublico.gov.br/gitlab/ | |
| 122 | +\end{tcolorbox} | |
| 123 | + | |
| 97 | 124 | \subsubsection{Acessando a página inicial do Projeto} |
| 98 | 125 | |
| 99 | -Logo após a criação do repositório ou acessando um repositório já criado, o usuário será apresentado a uma mesma tela, que segue um padrão ilustrado pela Figura X. | |
| 126 | +Logo após a criação do repositório ou acessando um repositório já criado, o usuário será apresentado a uma mesma tela, que segue um padrão ilustrado pela Figura \ref{fig:criacao_projetogitlab}. | |
| 100 | 127 | |
| 101 | -IMAGEM | |
| 128 | +\graphicspath{{figuras/}} | |
| 129 | +\begin{figure}[H] | |
| 130 | + \centering | |
| 131 | + \includegraphics[width=.95\textwidth]{tela_projetogitlab.png} | |
| 132 | + \caption{Tela de criação de projetos no Gitlab.} | |
| 133 | + \label{fig:criacao_projeto} | |
| 134 | +\end{figure} | |
| 102 | 135 | |
| 103 | 136 | Conforme visto na Figura temos: |
| 104 | 137 | |
| ... | ... | @@ -118,31 +151,81 @@ Caso não seja possível continuar com o projeto, é possível realizar a transf |
| 118 | 151 | |
| 119 | 152 | Para realizar a transferência, o usuário deve acessar a página principal do repositório, no menu superior do Gitlab deve encontrar a opção "Settings". Logo abaixo o usuário irá encontrar a opção "Transfer Project", que é visualizado na Figura X. |
| 120 | 153 | |
| 121 | -IMAGEM | |
| 154 | +\graphicspath{{figuras/}} | |
| 155 | +\begin{figure}[H] | |
| 156 | + \centering | |
| 157 | + \includegraphics[width=.95\textwidth]{transfer_project.png} | |
| 158 | + \caption{Caixa com a opção de transferência de projeto.} | |
| 159 | + \label{fig:transfer_project} | |
| 160 | +\end{figure} | |
| 161 | + | |
| 162 | + | |
| 163 | +Nessa caixa, dentro da opção "Namespace" o usuário deve escolher o novo dono do projeto, que pode ser um membro do projeto, ou um grupo o qual o usuário seja dono. | |
| 122 | 164 | |
| 123 | -Nessa caixa, dentro da opção "Namespace" o usuário deve escolher o novo dono do projeto, que pode ser um membro do projeto, ou um grupo o qual o usuário seja dono. Logo selecionar o novo dono, basta clicar no botão "Transfer". Será necessário fornecer uma confirmação (nome do projeto, conforme está destacado na mensagem) e depois disso o projeto será do dono informado. | |
| 165 | +Logo que selecionar o novo dono, basta clicar no botão "Transfer" e será aberta uma popup. Nessa popup é necessário fornecer uma confirmação, que é o nome do projeto (de acordo com o link), conforme está destacado na Figura \ref{fig:confirm_transfer}. Após a confirmação, o projeto será repassado para o dono informado. | |
| 166 | + | |
| 167 | + | |
| 168 | +\graphicspath{{figuras/}} | |
| 169 | +\begin{figure}[H] | |
| 170 | + \centering | |
| 171 | + \includegraphics[width=.75\textwidth]{confirm_transfer.png} | |
| 172 | + \caption{Caixa com a confirmação de transferência do projeto.} | |
| 173 | + \label{fig:confirm_transfer} | |
| 174 | +\end{figure} | |
| 124 | 175 | |
| 125 | 176 | \subsubsection{Excluíndo o Projeto} |
| 126 | 177 | |
| 127 | 178 | Para excluir um projeto, o usuário deve acessar a página inicial do projeto e entrar nas configurações, escolhendo a opção "Settings", que está localizada na barra superior do Gitlab. |
| 128 | 179 | |
| 180 | +Na tela de configuração, o usuário deve localizar a opção "Remove project", conforme Figura \ref{fig:remove_project}. Depois deve selecionar o botão chamado de \includegraphics[width=2.65cm]{figuras/botao_removeproject.png} (Remove project). | |
| 129 | 181 | |
| 130 | -Na tela de configuração, o usuário deve localizar a opção "Remove project", conforme Figura X. Depois deve selecionar o botão chamado de "Remove project". | |
| 182 | +\graphicspath{{figuras/}} | |
| 183 | +\begin{figure}[H] | |
| 184 | + \centering | |
| 185 | + \includegraphics[width=1\textwidth]{remove_project.png} | |
| 186 | + \caption{Caixa com a opção de exclusão do projeto.} | |
| 187 | + \label{fig:remove_project} | |
| 188 | +\end{figure} | |
| 131 | 189 | |
| 190 | +Será aberta uma popup pedindo para confirmação da exclusão do projeto, para isso, é necessário digitar o nome do projeto de acordo com o destacado pela Figura \ref{fig:confirm_remove} (geralmente o nome do projeto é de acordo com o link). Feito esses passos, o projeto já está excluído: | |
| 132 | 191 | |
| 133 | -Será aberta uma popup pedindo para o usuário confirmar a exclusão do projeto, para isso, ele deve digitar o nome do projeto de acordo com o destacado pela mensagem. Feito esses passos, o projeto já está excluído: | |
| 192 | +\graphicspath{{figuras/}} | |
| 193 | +\begin{figure}[htb!] | |
| 194 | + \centering | |
| 195 | + \includegraphics[width=.9\textwidth]{tela_exclusaoprojeto.png} | |
| 196 | + \caption{Caixa com a confirmação de exclusão do projeto.} | |
| 197 | + \label{fig:confirm_remove} | |
| 198 | +\end{figure} | |
| 134 | 199 | |
| 135 | -Observação: É importante ressaltar que uma vez que o projeto é excluído, não será possível recuperá-lo, então utilize essa opção se tiver certeza que deseja excluir. | |
| 200 | +\begin{tcolorbox}[colback=red!5,colframe=red!40!black,title=\textbf{Observação}] | |
| 201 | +É importante ressaltar que uma vez que o projeto é excluído, não será possível recuperá-lo, então utilize essa opção se tiver certeza que deseja excluir. | |
| 202 | +\end{tcolorbox} | |
| 136 | 203 | |
| 137 | 204 | \subsubsection{Adicionando membros aos projetos} |
| 138 | 205 | |
| 139 | 206 | É possível que um projeto tenha mais de um membro trabalhando simultaneamente. Isso permite que uma equipe possa trabalhar dentro de um projeto, sem a necessidade de cada um ter o seu próprio repositório. |
| 140 | 207 | |
| 141 | -Para adicionar membros no projeto, o usuário deve acessar o menu superior e selecionar a opção "Settings". Após, em um menu localizado na esquerda deve acessar a opção *MEMBERS*. | |
| 208 | +Para adicionar membros no projeto, o usuário deve acessar o menu superior e selecionar a opção "Settings". Após, em um menu localizado na esquerda deve acessar a opção \includegraphics[width=2.65cm]{figuras/botao_members.png}(Members). | |
| 209 | + | |
| 210 | +Na tela ilustrada pela Figura X, é apresentado todos os membros que fazem parte do projeto, assim como as permissões associadas\footnote{O gitlab permite que o dono do repositório atribua papéis para cada membro que vai fazer parte do projeto, mais informações são disponibilizadas em: https://softwarepublico.gov.br/gitlab/help/permissions/permissions}. Para adicionar um novo membro, basta acessar a opção \includegraphics[width=2.95cm]{figuras/botao_newmember.png}(New Project Member). Caso queira importar uma lista de outro projeto, selecione a opção \includegraphics[width=2.65cm]{figuras/botao_importmembers.png}(Import Member). | |
| 211 | + | |
| 212 | +\graphicspath{{figuras/}} | |
| 213 | +\begin{figure}[htb!] | |
| 214 | + \centering | |
| 215 | + \includegraphics[width=1\textwidth]{tela_members.png} | |
| 216 | + \caption{Tela com relação de membros que fazem parte do projeto.} | |
| 217 | + \label{fig:tela_members} | |
| 218 | +\end{figure} | |
| 142 | 219 | |
| 143 | -Na tela ilustrada pela Figura X, é apresentado todos os membros que fazem parte do projeto, assim como as permissões associadas\footnote{O gitlab permite que o dono do repositório atribua papéis para cada membro que vai fazer parte do projeto, mais informações são disponibilizadas em: https://softwarepublico.gov.br/gitlab/help/permissions/permissions}. Para adicionar um novo membro, basta acessar a opção *NEW PROJECT MEMBER*. Caso queira importar uma lista de outro projeto, selecione a opção *IMPORT MEMBERS*. | |
| 220 | +Na tela apresentada pela Figura \ref{fig:add_members}, o usuário deve informar o \textbf{nome do usuário} utilizado no SPB, assim como a permissão o qual ele vai ter no repositório. Depois disso, o usuário de salvar na opção \includegraphics[width=2.35cm]{figuras/botao_adduser.png} (Add users) e a pessoa irá fazer parte do projeto. | |
| 144 | 221 | |
| 145 | -Na tela apresentada pela Figura X, o usuário deve informar o \textbf{nome do usuário} utilizado no SPB, assim como a permissão o qual ele vai ter no repositório. Depois disso, o usuário de salvar na opção *ADD USERS* e a pessoa irá fazer parte do projeto. | |
| 222 | +\graphicspath{{figuras/}} | |
| 223 | +\begin{figure}[htb!] | |
| 224 | + \centering | |
| 225 | + \includegraphics[width=1.1\textwidth]{add_members.png} | |
| 226 | + \caption{Adição de membros no projeto.} | |
| 227 | + \label{fig:add_members} | |
| 228 | +\end{figure} | |
| 146 | 229 | |
| 147 | 230 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 148 | 231 | |
| ... | ... | @@ -153,13 +236,25 @@ O Gitlab permite a criação de grupos para trabalho conjunto entre os usuários |
| 153 | 236 | |
| 154 | 237 | \subsubsection{Criação do grupo} |
| 155 | 238 | |
| 156 | -Para criar um grupo, o usuário deve localizar a opção "Desenvolvimento" no menu superior, logo após deve acessar a opção "Grupos", a Figura X representa o menu de Grupos. | |
| 239 | +Para criar um grupo, o usuário deve localizar a opção "Desenvolvimento" no menu superior, logo após deve acessar a opção "Grupos", a Figura \ref{fig:tela_grupos.png} representa os grupos o qual o usuário faz parte. | |
| 157 | 240 | |
| 158 | -IMAGEM | |
| 241 | +\graphicspath{{figuras/}} | |
| 242 | +\begin{figure}[H] | |
| 243 | + \centering | |
| 244 | + \includegraphics[width=1\textwidth]{tela_grupos.png} | |
| 245 | + \caption{Listagem de grupos que o usuário participa.} | |
| 246 | + \label{fig:tela_grupos.png} | |
| 247 | +\end{figure} | |
| 159 | 248 | |
| 160 | -Após acessar o menu de Grupos, o usuário deve selecionar a opção "New Group", que é mostrado pela Figura X | |
| 249 | +Após acessar o menu de Grupos, o usuário deve selecionar a opção \includegraphics[width=2.35cm]{figuras/botao_newgroup.png}(New Group), que é mostrado pela Figura \ref{tela_grupos.png}. | |
| 161 | 250 | |
| 162 | -IMAGEM | |
| 251 | +\graphicspath{{figuras/}} | |
| 252 | +\begin{figure}[htb!] | |
| 253 | + \centering | |
| 254 | + \includegraphics[width=1.1\textwidth]{create_group.png} | |
| 255 | + \caption{Tela para criação de membros no Gitlab.} | |
| 256 | + \label{tela_grupos.png} | |
| 257 | +\end{figure} | |
| 163 | 258 | |
| 164 | 259 | O usuário deve preencher três campos, que são: |
| 165 | 260 | |
| ... | ... | @@ -169,7 +264,7 @@ O usuário deve preencher três campos, que são: |
| 169 | 264 | \item \textbf{Group avatar -} Imagem de avatar do grupo. |
| 170 | 265 | \end{itemize} |
| 171 | 266 | |
| 172 | -Após isso o grupo já está criado, e podem ser colocados projetos e membros para trabalho. O link para acesso o grupo (como mostrado em \ref{link:gitlab_grupo}) será: | |
| 267 | +Após isso o grupo já está criado, e podem ser colocados projetos e membros para trabalho. O link para acesso o grupo será: | |
| 173 | 268 | |
| 174 | 269 | \begin{lstlisting}[caption={Link de disponibilização do grupo}, label=link:gitlab_grupo] |
| 175 | 270 | https://softwarepublico.gov.br/gitlab/groups/NOMEDOGRUPO |
| ... | ... | @@ -179,49 +274,108 @@ Observação: Ao criar o grupo do software a equipe de administração do portal |
| 179 | 274 | |
| 180 | 275 | \subsubsection{Adicionando membros e permissões} |
| 181 | 276 | |
| 182 | -Após criar e acessar o grupo, o usuário deve localizar no menu superior direito (abaixo do cabeçalho do SPB), a opção "Members". A Figura X ilustra a página do projeto com a opção "Members" destacada. | |
| 183 | - | |
| 184 | -IMAGEM | |
| 185 | - | |
| 186 | -Logo após, o Gitlab vai oferecer uma tela que contém todos os membros que fazem parte do grupo, o usuário deve acessar a opção Add members e preencher o campo com o nome do usuário que deseja adicionar. Além disso, o dono do grupo deve adicionar o tipo de permissão que o usuário pode ter. Essas permissões estão disponíveis (em inglês) nesse \href{http://doc.gitlab.com/ce/ci/permissions/README.html}{link}. | |
| 277 | +Após criar e acessar o grupo, o usuário deve localizar no menu superior direito (abaixo do cabeçalho do SPB), a opção "Members". A Figura \ref{tela_groupmembers.png} ilustra a página com os membros de um grupo. | |
| 278 | + | |
| 279 | +\graphicspath{{figuras/}} | |
| 280 | +\begin{figure}[htb!] | |
| 281 | + \centering | |
| 282 | + \includegraphics[width=1\textwidth]{tela_groupmembers.png} | |
| 283 | + \caption{Listagem de membros de um projeto.} | |
| 284 | + \label{tela_groupmembers.png} | |
| 285 | +\end{figure} | |
| 286 | + | |
| 287 | +Logo após, o usuário deve acessar a opção \includegraphics[width=2.9cm]{figuras/botao_addmember.png}(Add members). Como visto na Figura \ref{fig:tela_cadastromember.png}, é necessário preencher o campo com o nome do usuário que deseja adicionar (ou mesmo alterar a permissão de um membro no projeto), além disso, o dono do grupo deve adicionar o tipo de permissão que o usuário terá dentro do grupo. | |
| 288 | + | |
| 289 | +\graphicspath{{figuras/}} | |
| 290 | +\begin{figure}[htb!] | |
| 291 | + \centering | |
| 292 | + \includegraphics[width=1\textwidth]{tela_cadastromember.png} | |
| 293 | + \caption{Tela para criação de membros no Gitlab.} | |
| 294 | + \label{fig:tela_cadastromember.png} | |
| 295 | +\end{figure} | |
| 296 | + | |
| 297 | +\begin{tcolorbox}[colback=red!5,colframe=red!40!black,title=\textbf{Observação}] | |
| 298 | +As permissões para cada tipo de usuário estão disponíveis (em inglês) nesse \href{http://doc.gitlab.com/ce/ci/permissions/README.html}{link}. | |
| 299 | +\end{tcolorbox} | |
| 187 | 300 | |
| 188 | 301 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 189 | 302 | |
| 190 | 303 | \subsection{Issue Tracker} |
| 304 | +\label{sub:issue_tracker} | |
| 305 | +O Gitlab possui um sistema para controle de problemas, requisições, demandas, bugs, entre outros. Esse sistema que chamado de "\textit{issue tracker}", facilita o controle do desenvolvimento do projeto. | |
| 306 | + | |
| 307 | +Para acessar a páginas de \textit{issue} do seu projeto, o usuário deve acessar a página inicial do projeto e localizar a opção \textit{"Issues"} no menu superior do Gitlab. Será disponibilizada uma tela semelhante a ilustrada pela Figura \ref{fig:issue_tracker.png}. | |
| 191 | 308 | |
| 192 | -O Gitlab possui um sistema para controle de problemas, requisições, demandas, bugs, entre outros. Esse sistema que é chamado de issue tracker, facilita o controle do desenvolvimento do projeto. | |
| 309 | +\graphicspath{{figuras/}} | |
| 310 | +\begin{figure}[htb!] | |
| 311 | + \centering | |
| 312 | + \includegraphics[width=1.05\textwidth]{issue_tracker.png} | |
| 313 | + \caption{Listagem de \textit{issues} de um projeto.} | |
| 314 | + \label{fig:issue_tracker.png} | |
| 315 | +\end{figure} | |
| 193 | 316 | |
| 194 | -Para acessar a páginas de issue do seu projeto, o usuário deve acessar a página inicial do projeto e localizar a opção "Issues" no menu superior do Gitlab. Será disponibilizada uma tela semelhante a ilustrada pela Figura X. | |
| 317 | +\subsubsection{Cadastrando/Alterando uma nova issue} | |
| 195 | 318 | |
| 196 | -IMAGEM | |
| 319 | +Acessando a tela principal de controle das issues, logo ao lado do campo de pesquisa de issues, existe uma opção chamada \includegraphics[width=2.9cm]{figuras/botao_newissue.png}(New Issue). Após selecionar a opção, uma tela de cadastro semelhante a ilustrada pela Figura \ref{fig:tela_cadastroissue.png} será apresentada. | |
| 197 | 320 | |
| 198 | -\subsubsection{Cadastrando uma nova issue} | |
| 321 | +\graphicspath{{figuras/}} | |
| 322 | +\begin{figure}[H] | |
| 323 | + \centering | |
| 324 | + \includegraphics[width=.8\textwidth]{tela_cadastroissue.png} | |
| 325 | + \caption{Cadastro de \textit{issue} no projeto.} | |
| 326 | + \label{fig:tela_cadastroissue.png} | |
| 327 | +\end{figure} | |
| 199 | 328 | |
| 200 | -Acessando a tela principal de controle das issues, logo ao lado do campo de pesquisa de issues, existe uma opção chamada *NEW ISSUES*. Após selecionar a opção, uma tela de cadastro semelhante a ilustrada pela Figura X será apresentada. | |
| 329 | +Nessa tela de cadastro o usuário deve informar \textit{(i)} o título problema/sugestão encontrada e \textit{(ii)} descrição do problema\footnote{nesse caso pode ser: passos para encontrar o problema, histórias de usuários, printscreens, fluxos de dados, imagens, entre outros conteúdos que possam ajudar o desenvolvedor visualizar o problema/sugestão}. | |
| 201 | 330 | |
| 202 | -IMAGEM | |
| 331 | +Também é possível responsabilizar um membro do projeto através do campo \includegraphics[width=2.4cm]{figuras/label_assignto.png}(Assign to), que será a dona da issue. Essa pessoa receberá todas as notificações sobre a issue, além de poder filtrar as issues de acordo com o seu nome. | |
| 203 | 332 | |
| 204 | -Nessa tela de cadastro o usuário deve informar o problema/sugestão encontrada | |
| 333 | +\subsubsection{Labels} | |
| 205 | 334 | |
| 206 | -\subsubsection{Tags} | |
| 335 | +O Gitlab permite a categorização das demandas de acordo com Labels, isto é, uma issue quando aberta pode ser categorizada de acordo com o seu tipo, ferramenta, release que será ajustada, entre outros filtros. Essas tags podem ser definidos pelos desenvolvedores ou donos de repositórios. | |
| 207 | 336 | |
| 208 | -Um issue tracker permite a categorização das demandas de acordo com tags, isto é, uma issue quando aberta pode ser categorizada de acordo com o seu tipo, ferramenta, release de ajuste, entre outros filtros, que podem ser definidos pelos desenvolvedores. | |
| 337 | +Para criar Labels, o usuário deve acessar o \hyperref[sub:issue_tracker]{Issue Tracker}. Existem duas formas de realizar o cadastro de labels, entre elas: | |
| 338 | + | |
| 339 | +\begin{itemize} | |
| 340 | + \item No menu de abas do issue tracker, há uma aba chamada Labels (conforme pode ser visto na Figura \ref{fig:menulateral_issues.png}) | |
| 341 | + \item No menu lateral há uma seção Labels. O botão \includegraphics[width=.3cm]{figuras/botao_labels.png}, pode ser utilizado para realizar a alterações nas labels. | |
| 342 | +\end{itemize} | |
| 343 | + | |
| 344 | +\graphicspath{{figuras/}} | |
| 345 | +\begin{figure}[H] | |
| 346 | + \centering | |
| 347 | + \includegraphics[width=.3\textwidth]{menulateral_issues.png} | |
| 348 | + \caption{Menu lateral contendo a seção labels.} | |
| 349 | + \label{fig:menulateral_issues.png} | |
| 350 | +\end{figure} | |
| 209 | 351 | |
| 210 | 352 | \subsubsection{Milestones} |
| 211 | 353 | |
| 212 | -Milestones são marcos do projeto, ou seja, são objetivos que devem estar prontos em uma determinada data. Esses marcos podem ser um conjunto de várias issues, merge requests e participantes associados. | |
| 354 | +Milestones são marcos do projeto, ou seja, são objetivos que devem estar prontos em uma determinada data. Esses marcos podem ser um conjunto de várias issues, merge requests e participantes (equipe) que estão associados naquele marco. | |
| 355 | + | |
| 356 | +Para criação de Milestones o usuário deve acessar a página inicial do projeto, em seguida deve localizar a opção \hyperref[sub:issue_tracker]{Issue} no menu superior. Será apresentada a mesma tela da Figura X (ISSUES). Após isso, o usuário deve selecionar a aba \includegraphics[width=.3cm]{figuras/botao_createmilestone.png} (Milestones), abaixo do menu principal do Gitlab. | |
| 213 | 357 | |
| 214 | -Para criação de milestones o usuário deve acessar a página inicial do projeto, em seguida deve localizar a opção Issues no menu superior. Será apresentada a mesma tela da Figura X (ISSUES). Após isso, o usuário deve selecionar a aba *MILESTONES*, abaixo do menu principal do Gitlab. | |
| 358 | +\graphicspath{{figuras/}} | |
| 359 | +\begin{figure}[H] | |
| 360 | + \centering | |
| 361 | + \includegraphics[width=.3\textwidth]{tela_criacaomilestone.png} | |
| 362 | + \caption{Menu lateral contendo a seção labels.} | |
| 363 | + \label{fig:menulateral_issues.png} | |
| 364 | +\end{figure} | |
| 215 | 365 | |
| 216 | -IMAGEM | |
| 366 | +Após preencher o título, a descrição do marco, além da data de fechamento do marco, basta selecionar a opção \includegraphics[width=.3cm]{figuras/botao_milestone.png} (Create milestone). Após isso, basta selecionar as issues, além das pessoas que vão fazer parte desse marco. | |
| 217 | 367 | |
| 218 | 368 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 219 | 369 | \subsection{Wiki} |
| 220 | 370 | |
| 221 | -O Gitlab também fornece uma wiki colaborativa, para que os desenvolvedores que não desejem colocar a documentação dentro do código fonte do software, possam colocar todos os artefatos relacionados a este software dentro do próprio sistema de wikis do Gitlab. | |
| 371 | +O Gitlab também fornece uma Wiki colaborativa para cada projeto. Essa wiki é utilizada como por exemplo, para que os desenvolvedores que não desejem versionar a documentação dentro do repositório do software, possam colocar todos os artefatos relacionados a este dentro da própria de wiki que o Gitlab fornece. | |
| 372 | + | |
| 373 | +Para acessar a Wiki do projeto, o usuário deve acessar a página inicial do projeto no Gitlab (repositório) e no menu superior direito (ao lado de "Settings"), deve acessar a opção Wiki. | |
| 222 | 374 | |
| 223 | -Para acessar a wiki, o usuário deve acessar a página inicial do projeto no Gitlab (repositório) e no menu superior direito (ao lado de "Settings"), deve acessar a opção Wiki. | |
| 375 | +Caso o projeto não possua nenhuma página wiki, é criado uma primeira página chamada de home, que serve de página inicial da wiki. As demais páginas podem ser criadas através do botão \includegraphics[width=.3cm]{figuras/botao_newpage.png}. | |
| 224 | 376 | |
| 377 | +\begin{tcolorbox}[colback=red!5,colframe=red!40!black,title=\textbf{Observação}] | |
| 225 | 378 | Existem 3 tipos de notações para escrita na Wiki do Gitlab, sendo a mais utilizada a Markdown. Toda a documentação e notação relacionada ao Markdown está disponível neste \href{https://softwarepublico.gov.br/gitlab/help/markdown/markdown}{link}. |
| 379 | +\end{tcolorbox} | |
| 226 | 380 | |
| 227 | 381 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ... | ... |
capitulos/6-git.tex
editaveis/abreviaturas.tex
| 1 | 1 | \begin{siglas} |
| 2 | 2 | %ORDEM ALFABETICA |
| 3 | 3 | \item[AGPL] GNU Affero General Public License |
| 4 | - \item[DC] Dublin Core | |
| 5 | 4 | \item[HTML] HyperText Markup Language |
| 6 | 5 | \item[HTTP] Hipertext Transfer |
| 7 | - \item[IBICT] Instituto Brasileiro de Informação em Ciência e Tecnologia | |
| 8 | 6 | \item[MVC] Model-View-Controller |
| 9 | - \item[OAI] Open Archives Initiative | |
| 10 | - \item[OAI-PMH] Open Archives Initiative Protocol for Metadata Harvesting | |
| 11 | - \item[Participa.br] Portal de Participação Social | |
| 12 | - \item[PNUD] Programa das Nações Unidas para o Desenvolvimento | |
| 13 | - \item[RDF] Resource Description Framework | |
| 14 | - \item[Set] Grupos de assuntos relacionados | |
| 15 | - \item[SERPRO] Serviço Federal de Processamento de Dados | |
| 16 | - \item[SPARQL] SPARQL Protocol and RDF Query Language | |
| 17 | - \item[TDD] Test Driven Development | |
| 18 | 7 | \item[URI] Identificador de Endereços na Internet |
| 19 | 8 | \item[XML] Extensible Markup Language. |
| 20 | 9 | \end{siglas} | ... | ... |
editaveis/informacoes.tex
| 1 | 1 | % Dados pessoais |
| 2 | -\autor{Secretaria de Tecnologia da Informação} | |
| 3 | -\curso{Engenharia de Software} | |
| 2 | +\autor{Ministério do Planejamento, Orçamento e Gestão\\ | |
| 3 | +Secretaria de Tecnologia da Informação} | |
| 4 | 4 | |
| 5 | 5 | % Dados do trabalho |
| 6 | -\titulo{Manual do SPB | |
| 7 | -} | |
| 6 | +\titulo{MANUAL DE ADMINISTRAÇÃO DO SOFTWARE E COMUNIDADES DO PORTAL DO SOFTWARE PÚBLICO BRASILEIRO} | |
| 8 | 7 | \data{2016} |
| 9 | -\palavraChaveUm{SPB} | |
| 10 | -\palavraChaveDois{Software Público} | |
| 11 | 8 | |
| 12 | -% Dados da orientacao | |
| 13 | -\orientador{} | |
| 14 | -\coorientador{} | |
| 15 | -% Dados para a ficha catalográfica | |
| 16 | -\cdu{02:141:005.6} | |
| 17 | - | |
| 18 | -% Dados da aprovação do trabalho | |
| 19 | -\dataDaAprovacao{01/12/2014} | |
| 20 | -\membroConvidadoUm{} | |
| 21 | -\membroConvidadoDois{} | |
| 22 | 9 | ... | ... |
20.1 KB
49.8 KB
2.07 KB
1.6 KB
2.24 KB
2.17 KB
1.55 KB
460 Bytes
1.56 KB
1.57 KB
1.8 KB
1.57 KB
2.53 KB
1.83 KB
1.95 KB
2.13 KB
33.6 KB
37.9 KB
31 KB
39.9 KB
50.3 KB
46 KB
45.9 KB
1.66 KB
21.5 KB
7.82 KB
75.9 KB
20.2 KB
43.9 KB
17 KB
39.5 KB
33.9 KB
33.7 KB
36.8 KB
23.3 KB
12.1 KB
13.3 KB
84.6 KB
40.9 KB
24.6 KB
fixos/informacoes.tex
| 1 | 1 | \local{Brasília, DF} |
| 2 | -\instituicao{% | |
| 3 | - Ministério do Planejamento | |
| 4 | -} | |
| 5 | -\tipotrabalho{Trabalho de Conclusão de Curso} | |
| 6 | -\preambulo{Manual de utilização do Novo Portal do Software Público.} | |
| 2 | +%\instituicao{Ministério do Planejamento, Orçamento e Gestão} | |
| 3 | +\tipotrabalho{Manual de utilização do Novo Portal do Software Público Brasileiro.} | |
| 4 | +\preambulo{} | ... | ... |
fixos/novosComandos.tex
| 1 | -\newcommand{\curso}[1]{\def\imprimircurso{#1}} | |
| 2 | - | |
| 3 | -\newcommand{\palavraChaveUm}[1]{\def\imprimirpalavrachaveum{#1}} | |
| 4 | -\newcommand{\palavraChaveDois}[1]{\def\imprimirpalavrachavedois{#1}} | |
| 5 | - | |
| 6 | -\newcommand{\cdu}[1]{\def\nomecdu{#1}} | |
| 7 | -\newcommand{\dataDaAprovacao}[1]{\def\imprimirdatadaaprovacao{#1}} | |
| 8 | - | |
| 9 | -\newcommand{\membroConvidadoUm}[1]{\def\imprimirmembroconvidadoum{#1}} | |
| 10 | -\newcommand{\membroConvidadoDois}[1]{\def\imprimirmembroconvidadodois{#1}} | |
| 11 | - | |
| 12 | -\newcommand\BackgroundPic{% | |
| 13 | - \put(0,0){% | |
| 14 | - \parbox[b][\paperheight]{\paperwidth}{% | |
| 15 | - \vfill | |
| 16 | - \centering | |
| 17 | - \includegraphics[width=\paperwidth,height=\paperheight,% | |
| 18 | - keepaspectratio]{figuras/capa.eps}% | |
| 19 | - \vfill | |
| 20 | - } | |
| 21 | - } | |
| 22 | -} | |
| 23 | - | |
| 24 | -\renewcommand{\imprimircapa}{% | |
| 25 | - \begin{capa}% | |
| 26 | - \center | |
| 27 | - \AddToShipoutPicture*{\BackgroundPic} | |
| 28 | - | |
| 29 | -% \begin{huge} | |
| 30 | -% \textbf{\textsc{Trabalho de Conclusão de Curso}} | |
| 31 | -% \end{huge} | |
| 32 | - | |
| 33 | - \vspace*{2.7in} | |
| 34 | - {\textbf{\large\imprimirinstituicao}} | |
| 35 | - \par | |
| 36 | - {\textbf{\large\imprimircurso}} | |
| 37 | - | |
| 38 | - \vspace{0.5in} | |
| 39 | - | |
| 40 | - {\ABNTEXchapterfont\bfseries\LARGE\imprimirtitulo} | |
| 41 | - \vspace*{\fill} | |
| 42 | - | |
| 43 | - \begin{flushright} | |
| 44 | - \textbf{{\large{Autor: \imprimirautor}}} | |
| 45 | - \par | |
| 46 | - \textbf{{\large{Orientador: \imprimirorientador}}} | |
| 47 | - \end{flushright} | |
| 48 | - | |
| 49 | - \vspace*{0.2in} | |
| 50 | - \textbf{{\large\imprimirlocal}} | |
| 51 | - \par | |
| 52 | - \textbf{{\large\imprimirdata}} | |
| 53 | - | |
| 54 | - \vspace*{2.2in} | |
| 55 | - \end{capa} | |
| 56 | -} | |
| 57 | - | |
| 58 | 1 | \newcommand{\thickhline}{% |
| 59 | 2 | \noalign {\hrule height 2pt}% |
| 60 | 3 | } | ... | ... |
manual.tex
| ... | ... | @@ -8,12 +8,9 @@ |
| 8 | 8 | |
| 9 | 9 | \begin{document} |
| 10 | 10 | |
| 11 | -\frenchspacing | |
| 12 | -%\imprimircapa | |
| 11 | +\frenchspacing | |
| 13 | 12 | \imprimirfolhaderosto* |
| 14 | 13 | |
| 15 | -%\input{fixos/fichaCatalografica} | |
| 16 | -%\input{editaveis/resumo} | |
| 17 | 14 | \input{fixos/listasAutomaticas} |
| 18 | 15 | \input{editaveis/abreviaturas} |
| 19 | 16 | \input{fixos/indiceAutomatico} |
| ... | ... | @@ -31,8 +28,7 @@ |
| 31 | 28 | \input{capitulos/6-git} |
| 32 | 29 | \input{capitulos/7-mezuro} |
| 33 | 30 | |
| 34 | -\bookmarksetup{startatroot} | |
| 35 | - | |
| 31 | +%\bookmarksetup{startatroot} | |
| 36 | 32 | \postextual |
| 37 | 33 | \bibliography{bibliografia} |
| 38 | 34 | \printindex | ... | ... |