Treinamento DCPPN⚓︎
A equipe da Assessoria de Inteligência de Dados (AID) acredita que o compartilhamento de conhecimento é central para que o desenvolvimento e consolidação de melhorias se tornem uma realidade nas mais diversas equipes e organizações.
Nesse sentido, a AID e a Diretora Central de Planejamento, Programação e Normas (DCPPN) está empenhada em uma sequência de reuniões para tratar de temas como filosofia Doc as Code, Git, GitHub, Markdown, dentre outros.
Acompanhe os encontros gravados abaixo:
1º encontro⚓︎
O que foi tratado nesse encontro⚓︎
- Apresentação da Filosofia Docs as Code
- Apresentação das ferramentas Git e GitHub
- Criação de Conta no GitHub
- Inclusão de membros na organização Splor
- Criação de repositórios
- Edição do projeto usando o Codespace
2º encontro⚓︎
O que foi tratado nesse encontro⚓︎
Como incluir um novo post no blog do Handbook⚓︎
- Criar issue no repositório (Handbook)
- Abrir Codespace e realizar setup do projeto
- Criar nova branch:
git checkout -b <nome da nova branch>
- Editar arquivo Authors
- Incluir post no blog do handbook
- Ligar o servidor e conferir alterações:
poetry run mkdocs serve
- Enviar alterações para o repositótio:
git commit
+git push origin <nome da branch criada>
- Abrir Pull Request e colocar @raianecardoso como revisora
Informações de Setup do Repositório⚓︎
Considerando que utilizamos o poetry
para gerenciar as dependências do projeto, é necessário instalar a ferramenta, via terminal, com o auxílio do pipx
, que é um gerenciador de pacotes.
- Instalar pipx: official pipx installation instructions
- Instalar Poetry: official poetry installation instructions
- Após a instalação do Poetry, Instalar das dependências do projeto:
- Ligar o servidor local
3º encontro⚓︎
O terceiro encontro não foi gravado, pois se tratou de uma sessão de tira dúvidas.
4º encontro⚓︎
O que foi tratado nesse encontro⚓︎
Como o Git funciona:⚓︎
- Iniciar repositório em uma pasta com
git init
- Alterações com
git status
- Realizar commits com
git add [nome doc alterado]
ougit add
+git commit
- mostrar a mágica do
git reset --hard <ID do commit>
- mostrar fluxo de trabalho:
git status
+git pull origin <branch name>
+git add
+git commit
+git push origin <nome da branch>
Alteração de um post no handbook com vídeo⚓︎
- Incluir vídeo no YouTube
- Preparar texto resumo com o GPT em markdown
- Abrir o repositório usando Codespaces
- Abrir nova branch:
git checkout -b <nome da nova branch>
- Alterar post
- Commitar mudanças:
git add [nome doc alterado]
ougit add
+git commit
- Enviar alterações para o repositório:
git push origin <nome da branch criada>
- Abrir PR no GitHub
5º encontro⚓︎
O quinto encontro não foi gravado, pois foi foram feitas as mesmas atividades do 4º encontro na intenção de fixar as etapas do processo de trabalho.
🚨Fique ligado, pois logo teremos novos encontros!