Documentação de suporte dos serviços do C3SL

Este repositório contém a documentação dos serviços do departamento de inormática e do grupo de pesquisa C3SL

suporte.

• Documentação de suporte dos serviços do C3SL
• Como começar
  • Clone ssh
  • Clone via https
• Organização do repositório
• Como Contribuir

Como começar

O primeiro passo é realizar o clone do repositório

Clone ssh

O clone por via ssh é recomendado visto que utiliza a chave ssh cadastrada no gitlab, sem precisar autenticar por senha.

git clone git@gitlab.c3sl.ufpr.br:c3sl/c3docs/suporte.git

Clone via https

O clone do repositório por https é desencorajado visto que a cada nova alteração é necessário entrar com as credencias de acesso do gitlab, mas pode ser feito com o comando abaixo:

git clone https://gitlab.c3sl.ufpr.br/c3sl/c3docs/suporte.git

Após clonar, edite a documentação localizada em sources e quando terminar faça push para o gitlab.

Organização do repositório

O repositório é dedicado a documentação e esta orgazanizado da seguinte maneira:

• build/ Diretório onde os arquivos compilados vão.
• cz.yaml Arquivo de configuração do commitizen
• .git Diretório de configuração do git
• .gitignoreArquivo com padrões de nomes que o git deve ignorar ao realizar git add ou git stage
• Makefile Makefile para fazer o build da documentação, resultado vai para o diretório build
• Pipfile Arquivo do pipenv para criar ambiente do python para fazer build
• Pipfile.lock Arquivo do pipenv para criar ambiente do python para fazer build
• .pre-commit-config.yaml Arquivo de configuração do pre-commit
• README.md arquivo de readme do repositório.
• .readthedocs.yaml Arquivo de configuração do readthedocs
• requirements.txt Arquivos com listas de modulos python para fazer build da documentação, deve ser igual ao Pipfile
• LICENSE arquivo de licença
• .gitlab-ci.yml Arquivo do Gitlab CI
• scripts/ Diretório com scripts variados.
  • generate-requeriments.sh Script que gera o arquivo requirements.txt a partir do Pipfile.
• source/ Diretório da documentação.
  • conf.py Arquivo de configuração do sphinx
  • index.rst Primeira página da documentação
  • pages/ Diretório com as páginas da documentação
    • quickstart-rst.rst Página com dicas de rst com sphinx
    • quickstart-conf.rst Página com dicas de configuração do conf.py
    • quickstart-rdt.rst Página de como incluir um repositório em docs
  • _static/ Diretório para armazenar arquivos estáticos, como imagens, gifs e etc.
  • _templates/ Diretório para armazenar estilização das páginas, css, html e etc.

Como Contribuir

Para contribuir com a documentação realizer clone e faça merge request que passará pela curadoria. Contribuições são bem vindas e pode resultar em certificados de horas formativas na modalidade de voluntáriado, dependendo da contribuição para documentação.