docs: documentação jupyter notebook

This commit is contained in:
felipesantanafs 2025-11-24 21:58:48 -03:00
parent 7b7e6666c2
commit fa782fcc91
60 changed files with 262 additions and 24 deletions

View File

@ -1,32 +1,69 @@
---
title: 1) Onboarding do Hub
title: 1) Onboarding do Hub (sem Git)
tags:
- nivel/basico
---
>[!warning]
>
>Isso aqui é um Tutorial direcionado apenas para os Membros da FEA.dev
>
>Se você optar por esse método, as páginas o guia 2 pode ser ignorado!
>[!info]
>
Este guia ensina qualquer pessoa a **acessar, editar e publicar** o Hub hospedado no **GitHub da organização** usando **Obsidian + Git + Quartz**.
>Este guia ensina qualquer pessoa a **acessar, editar e publicar** o Hub hospedado no **GitHub da organização** usando **Obsidian + Github**. Essa é a forma **mais rápida**, mas fica **mais limitado** em relação ao acesso ao ecossistema.
## 1) O que você vai precisar (prérequisitos)
- **Acesso ao repositório** da organização (peça para te adicionarem como _member_ e com permissão de escrita no repo do Hub).
- Ter o **Git e VsCode** instalados na sua máquina.
- Ter também o **Obsidian** instalado (para editar os arquivos Markdown `.md`)
- Ter o **Obsidian** instalado (para editar os arquivos Markdown `.md`)
>[!info]
> Links oficiais para download, caso ainda não tenha instalado:
>
> - [Git](https://git-scm.com)
> - [VsCode](https://code.visualstudio.com/)
> - [Obsidian](https://obsidian.md/)
> Link oficial para download, caso ainda não tenha instalado:
> [Obsidian](https://obsidian.md/)
## 2) Transformando seu Arquivo .docx para .md
Nesse primeiro caso iremos mostrar passo a passo como se upar um arquivo aos moldes de relatório (originalmente um arquivo em .docx) para o Hub.
1- Abra o seu arquivo no Google Docs: [Google Docs](https://docs.google.com/?hl=pt-BR)
2- Com o arquivo aberto, clique na opção "Arquivos" no canto superior esquerdo (imagens abaixo como exemplo ilustrativo apenas):
3- Clique em seguida em Baixar e depois selecione em Markdown (.md):
4- Desse tópico era isso, é esperado que esse arquivo esteja na sua pasta de Downloads
## 3) Fazendo ajustes necessários no arquivo pelo Obsidian
1- Abra o aplicativo do Obsidian na sua máquina;
2- No canto inferior esquerdo, clique onde está escrito "Obsidian Vault" (se você já utilizar o Obsidian, clique no nome do vault que esteja ali)
3- Clique em "Gerenciar cofres..."
4- Clique em "Criar um novo cofre":
5- Dê um nome para o seu cofre e selecione uma pasta para colocar os arquivos .md dentro;
6- Dentro do seu Explorador de Arquivos, transfira o arquivo .md para a pasta que acabou de escolher anteriormente;
7- Depois de ter feito isso
## Considerações Finais:

View File

@ -1,6 +1,27 @@
---
title: 2) Criando seu Arquivo
title: 2) Onboarding do Hub (com Git)
tags:
- nivel/basico
---
[Em Breve]
>[!warning]
>
>Isso aqui é um Tutorial direcionado apenas para os Membros da FEA.dev.
>Se você optar por esse método, o guia 1 pode ser ignorado!
>[!info]
>Este guia ensina qualquer pessoa a **acessar, editar e publicar** o Hub hospedado no **GitHub da organização** usando **Vscode + Obsidian + Git +Github**. Essa é forma **mais lenta**, mas é a **mais completa** e ter a visualização completa acerca ecossistema.
## 1) O que você vai precisar (prérequisitos)
- **Acesso ao repositório** da organização (peça para te adicionarem como _member_ e com permissão de escrita no repo do Hub).
- Ter o **Git e VsCode** instalados na sua máquina.
- Ter também o **Obsidian** instalado (para editar os arquivos Markdown `.md`)
>[!info]
> Links oficiais para download, caso ainda não tenha instalado:
>
> - [Git](https://git-scm.com)
> - [VsCode](https://code.visualstudio.com/)
> - [Obsidian](https://obsidian.md/)

View File

@ -1,6 +0,0 @@
---
title: 3) Ajustando Imagens
tags:
- "#nivel/basico"
---
[Em breve]

View File

@ -0,0 +1,185 @@
---
title: 3) Arquivos Jupyter Notebook
tags:
- "#nivel/basico"
---
>[!warning]
>
>Isso aqui é um Tutorial direcionado apenas para os Membros da FEA.dev
>
>Todos os atalhos colocados são para Windows, se você utiliza Mac ou outro sistema operacional, pesquise eles por fora!
>[!info]
>Este guia ensina qualquer pessoa a **acessar, editar e publicar** o Hub hospedado no **GitHub da organização** usando **Vscode + Obsidian + Github**.
## 1) O que você vai precisar (prérequisitos)
- Ter o **VsCode** instalado na sua máquina.
- Ter também o **Obsidian** instalado (para editar os arquivos Markdown `.md`)
>[!info]
> Links oficiais para download, caso ainda não tenha instalado:
>
> - [VsCode](https://code.visualstudio.com/)
> - [Obsidian](https://obsidian.md/)
## 2) Transformando .ipynb em .md
1- Abra o seu VsCode;
2- Abra a pasta em que o seu arquivo está inserido (não abra apenas o arquivo diretamente, já te adianto não funcionará!), você pode fazer isso pelo atalho Crtl + Shift + E ou acessar pelo ícone lateral (imagem abaixo como referência):
![[Pasted image 20251124192930.png]]
![[Pasted image 20251124192949.png]]
Selecione a pasta que deseja e será aberto outra janela do VsCode, no meu caso ficou assim:
![[Pasted image 20251124193118.png]]
Com a pasta aberta e com o arquivo desejado, siga as próximas instruções;
3- Abra o seu terminal, você pode fazer isso pelo atalho Crtl + Shift + Aspas ou arrastando para cima a barra inferior do Vscode, dessa forma:
![[Pasted image 20251124193637.png]]
Você verá algo nesse sentido:
![[Pasted image 20251124193817.png]]
O caminho da sua pasta deve estar presente (sublinhado em vemelho);
4- Instale essa biblioteca, se não tiver :
```python
pip install jupyter nbconvert
```
![[Pasted image 20251124194222.png]]
5- Converte o notebook pra Markdown:
```python
jupyter nbconvert --to markdown introducao_poo_fea_dev.ipynb
```
No meu caso o meu arquivo de exemplo se chama "introducao_poo_fea_dev", altere para o nome do seu respectivo arquivo;
![[Pasted image 20251124194639.png]]
Se tudo der certo, após o comando ser rodado, espera-se que já na pasta esteja o novo arquivo em Markdown
## 3) Ajustando o Arquivo para a Formatação do Hub
Aqui vai ser abordado mais ou menos os passos já ensinados no guia 1, então serei um pouco mais direto.
Qualquer dúvida dê um revisada no passo a passo mais detalhado no guia anterior!
1- Abra seu arquivo agora em Markdown agora no Obsidian;
![[Pasted image 20251124195152.png]]
3- Se tiver algum título no seu documento remova ele e substitua pela formatação do Obsidian.
(No meu caso não tenho, "introducao_poo_fea_dev" é o nome do arquivo)
Você escreverá três hífens ( "-" ) no topo da página e selecione o as propriedades "title" e "tags":
```
---
```
![[Pasted image 20251124195849.png]]
Dê o título apropriado ao seu trabalho e nas tags padronize, de acordo com essas:
```
nível:
#nivel/avancado #nivel/intermediario #nivel/basico
trilhas:
#trilha/finquant #trilha/ia #trilha/ciencia-de-dados #trilha/extras
```
Na linha abaixo do painel de propriedades, dê seus créditos pelo trabalho! Use essa formatação como referência:
```
_**Autores:** Autor(a) · Autor(a) · Autor(a)_
```
Obs: Se for apenas um autor não utilize a separação de pontos
Pronto seu arquivo seu arquivo está certinho em Markdown, é recomendado dar um revisada para verificar nada faltando.
4- Dê um Ctrl + S para salvar o arquivo e pode fechar o Obsidian
## 4) Dando Pull Request no Github
1- Entre no repositório do Hub: [Repositório do Hub](https://github.com/fea-dev-usp/fea-dev-usp.github.io)
![[Pasted image 20251124204150.png]]
2- Entre na pasta "Content":
![[Pasted image 20251124204250.png]]
3- Entre na Trilha que pertença o seu respectivo arquivo (se tiver dúvida em qual delas colocar pergunte a um membro de Tech), no meu caso aqui o meu arquivo pertence a trilha de '03-ciencia-de-dados'
![[Pasted image 20251124204448.png]]
4- Selecione a pasta referente ao seu ano e ao seu semestre (no caso da imagem ainda só existia a 2025-s2)
![[Pasted image 20251124204615.png]]
5- Um vez estando na pasta correta clique em 'Add File';
![[Pasted image 20251124204811.png]]
6- Clique em 'Upload Files':
![[Pasted image 20251124204849.png]]
7- Clique em 'choose your files' e coloque o seu arquivo
![[Pasted image 20251124204956.png]]
Na aba "ADD files via upload" preencha no seguinte formato:
```
[Ano-semestre] Tema - Nível
```
Na aba "Add an Optional extended description..." preencha no seguinte formato:
```
Tipo de arquivo: Projeto Autoral / Jupiter Notebook / Aula Dev Ensina
Trilha: Ciência de Dados / FinQuant / Extras / IA
Nível de dificuldade: Iniciante / Intermediário / Avançado
Tópicos abordados: Dê uma Breve descrição
```
No meu caso ficou assim:
![[Pasted image 20251124214347.png]]
Mais objetivamente dessa forma:
```
Tipo de arquivo: Jupiter Notebook
Trilha: Ciência de Dados
Nível de dificuldade: Avançado
Tópicos abordados:
- O que é Programação Orientada a Objetos (POO)
- Conceitos de classe, objeto, atributos e métodos
- Exemplos em Python
```
Por favor tentem manter essa estrutura!
OBS: Deixem marcado a primeira bolinha, deixem o Commit na branch 'v4'
8- Para validar se tudo deu certo, pode checar isso na aba 'Actions':
![[Pasted image 20251124214636.png]]
Se ficar ainda em amarelo as alterações ainda não foram submetidas ao Hub, esperem ficar em azul;
![[Pasted image 20251124214817.png]]
Tudo certo agora! Podem atualizar o Hub e tudo estará lá bonitinho!

View File

@ -1,7 +1,8 @@
---
title: Guia do Hub
tags:
- nivel/basico
---
## Guia do Hub
Bem-vindo ao centro de documentação do FEA.dev Hub, para subir corretamente seu arquivo leias os 4 arquivos obrigatórios abaixo:

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 223 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 233 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 161 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB