Skip to content

Latest commit

 

History

History
402 lines (275 loc) · 12.6 KB

CONTRIBUTING.md

File metadata and controls

402 lines (275 loc) · 12.6 KB
Raw

Contribuindo

Obrigado por considerar contribuir com a Base dos Dados. Nesse guia vamos mostrar como contribuir com o website da Base dos Dados.

Como contribuir

  • Melhorias e correções no webiste. Verifique nossas issues abertas para um ponto de início
  • Sugestões de melhorias na interface, typos, design, etc.. Você pode dar feedback ou sugestões em nossas issues
  • Escrever postagens no nosso blog.

Iniciando

  • Faça o fork desse repositório
    • Desmarque a opção Copy the main branch only
  • Clone seu fork
  • Entre no respositório clonado
    • cd website

Adicionando posts

Esse seção cobre o processo de contruição no blog da Base dos Dados.

Algumas informações:

  • Todas as postagens estão em next/blog/
  • Cada post é um arquivo markdown (.md) com o caminho da postagem (slug) no nome do arquivo
  • As imagens de cada postagem está em public/blog/<slug> dentro da pasta com o nome do arquivo markdown.

Exemplo: o arquivo next/blog/analisando-precos-de-combustiveis-com-a-bd.md tem uma pasta em next/public/analisando-precos-de-combustiveis-com-a-bd/ onde fica todas as imagens usadas no post.

Depois de clonar o repositório crie uma branch a partir do ramo blog

git checkout -b blog-meu-post blog

Crie um arquivo markdown em next/blog/:

Important

O nome do arquivo será o caminho do post. Se você criar um arquivo analisando-precos-de-combustiveis-com-a-bd.md ele será publicado em basedosdados.org/blog/analisando-precos-de-combustiveis-com-a-bd. Evite caracteres como ç e acentos, utilize hífen (-) para separar as palavras.

O post é escrito em Markdown com algumas diferenças que serão abordadas logo abaixo. Veja a sintaxe básica em Markdown Guide e em Markdown Cheat Sheet

Metadados

Os metadados do post são em YAML em um bloco no topo do arquivo delimitado por --- e ---. Preencha os metadadaos do seu post, título, descrição, etc.

  • title: Título do post
  • description: Descrição do post
  • date
    • created: Data de criação do post, deve ser uma string "2024-02-29" no formato ISO 8601.
    • updated (opcional): Data que o post foi atualizado. Mesmo formato de created
  • thumbnail (opcional): Caminho para uma imagem.
  • categories (opcional): uma lista com as categorias.
    • As postagens com categoria estarão em /blog/category/categoryName
    • Não está definido se um post pode ter mais de uma categoria
  • authors (recomendado): Uma lista de autores. Cada autor tem o seguintes campos:
    • name (obrigatório): Nome do autor
    • role (opcional): Qual foi o papel dessa pessoa no post
    • social (opcional): Uma URL para alguma rede social da pessoa (github, website, linkedin)
    • avatar (opcional): URL para uma imagem

Exemplo para como-a-disparidade-salarial-por-genero-e-raca-evoluiu-ao-longo-dos-anos.md:

---
title: Como a disparidade salarial por gênero e raça evoluiu ao longo dos anos?
description: >-
  Analisando a disparidade salarial por gênero e raça com dados do CAGED e o
  datalake público da BD
date:
  created: "2024-02-29"
thumbnail: /blog/como-a-disparidade-salarial-por-genero-e-raca-evoluiu-ao-longo-dos-anos/image_0.png
categories: [analise]
authors:
  - name: Thais Filipi
    role: Análise e texto
    social: https://www.linkedin.com/in/thaismdr/
    avatar: https://media.licdn.com/dms/image/v2/C4E03AQFstxqWabAyUA/profile-displayphoto-shrink_200_200/profile-displayphoto-shrink_200_200/0/1584489568236?e=2147483647&v=beta&t=mol7Kc8PgxgJatgvNYRkyffL8opuIgFgRdiY7vXB1HA
  - name: Giovane Caruso
    role: Edição de texto
    social: https://www.linkedin.com/in/giovanecaruso/
---

Não é novidade que a desigualdade de gênero e raça reflete na empregabilidade e na remuneração dentro do mercado de trabalho no Brasil. Apesar da legislação que proíbe a disparidade salarial entre indivíduos desempenhando a mesma função, a realidade é que tais disparidades persistem. Recentemente, o Governo Federal tomou medidas para enfrentar esse desafio ao publicar uma portaria que regulamenta a Lei nº 14.611/2023. Essa lei cria mecanismos para equalizar salários entre homens e mulheres ocupando o mesmo cargo em empresas com pelo menos 100 funcionários.

## Análise

### Disparidade salarial entre 2020 e 2023

Ao analisarmos o salário médio por grupos, ficou evidente a vantagem que homens brancos mantêm em relação aos demais. Em 2023, o salário médio dos homens brancos foi de R$2.087, 25,6% maior do que o salário médio das mulheres negras, que foi de R$1.662. Uma forma de visualizar as diferenças é ver o salário médio de homens negros, mulheres negras e brancas enquanto porcentagem do salário médio de homens brancos, como você pode conferir no gráfico abaixo.

Seções

Utilize seções (cabeçalhos) para estruturar seu post. Um bom exemplo é o post O Soberano mítico: Processo de limpeza dos dados do Siconfi

## TL;DR

## Finbra x Siconfi

## Considerações sobre os conjuntos de dados

### A forma estrutural em que os dados são disponibilizados.

#### Alguns detalhes da arquitetura

##### 1989-2012

##### 2013-2020

#### Terminado o processo de compatibilização, chamamos a base inteira de Siconfi

## O processo de limpeza e compatibilização

### Adição de ID Município para os anos de 1989-2012

### Compatibilização das portarias e estágios

### Passo 1: Empilhar todas as tabelas de 1989–2020 com as colunas originais

### Passo 2: Padronizar nome das contas entre anos

### Passo 3: Criar IDs que identificassem contas de forma consistente entre/intra anos

### Passo 4: Criar a coluna de estágios para os anos que não o tinham (1989–2012)

### Passo 5: Padronização de moeda

## Considerações finais

Important

Os cabeçalhos iniciam no nível dois ## ao invés de um #

Negrito

Texto em negrito é delimitado por ** ao seu redor.

Texto em **negrito**

Resultado:

Texto em negrito

Itálico

Texto em itálico é delimitado por _ ao seu redor.

Texto em _itálico_

Resultado:

Texto em itálico

Lista

Lista pode ser enumerada ou não enumerada.

Lista enumerada

1. Primeiro item
2. Segundo item
3. Primeiro item do segundo item
4. Segundo item do segundo item

Resultado:

  1. Primeiro item
  2. Segundo item
  3. Primeiro item do segundo item
  4. Segundo item do segundo item

Lista não enumerada

- Primeiro item
- Segundo item
  - Primeiro item do segundo item
  - Segundo item do segundo item

Resultado:

  • Primeiro item
  • Segundo item
    • Primeiro item do segundo item
    • Segundo item do segundo item

Bloco de códigos

Adicione blocos de códigos entre os tripos backtick (crase) `. Adicione o nome da linguagem na abertura, depois dos três backticks.

Python:

```python
print("Hello World!!")
```

Resultado:

print("Hello World!!")

R

```r
library(basedosdados)
data <- basedosdaos::read_sql("
SELECT
  *
FROM
  `basedosdados.br_bcb_sicor.microdados_operacao`
LIMIT 100
")
```

Resultado:

library(basedosdados)
data <- basedosdaos::read_sql("
SELECT
  *
FROM
  `basedosdados.br_bcb_sicor.microdados_operacao`
LIMIT 100
")

SQL

```sql
SELECT
  *
FROM
  `basedosdados.br_bcb_sicor.microdados_operacao`
LIMIT 100
```

Resultado:

SELECT
  *
FROM
  `basedosdados.br_bcb_sicor.microdados_operacao`
LIMIT 100

Inline code

Inline code é util para citar parte de um código, nome de uma coluna, tabela, variável.

Inlice code é delimitado por crase ao seu redor, `texto-a`

Exemplo:

A tabela `escola` tem a granularidade de cada escola por cada ano. A identificação básica de cada unidade é feita pelas variáveis `id_escola` e `ano`.

Resultado:

A tabela escola tem a granularidade de cada escola por cada ano. A identificação básica de cada unidade é feita pelas variáveis id_escola e ano.

Links

Links são adicionandos usando a seguinte sintaxe: [texto](URL)

[Acesse o Google](https://www.google.com)

Resultado:

Acesse o Google

Warning

Não coloque a URL no texto, exemplo: [https://www.google.com](https://www.google.com). Sempre adicione um texto informativo

Para adicionar links para outro post ou para um dataset ou tabela use links relativos e não absolutos.

✅ Correto

Veja a análise [Qual a relação das chuvas extremas no RS com as mudanças climáticas?](/blog/qual-a-relacao-chuvas-extremas-no-rs-com-as-mudancas-climaticas)

Acesse os dados no INMET por [aqui](/dataset/782c5607-9f69-4e12-b0d5-aa0f1a7a94e2).

❌ Errado

Veja a análise [Qual a relação das chuvas extremas no RS com as mudanças climáticas?](https://basedosdados.org/blog/qual-a-relacao-chuvas-extremas-no-rs-com-as-mudancas-climaticas)

Acesse os dados no INMET por [aqui](https://basedosdados.org/dataset/782c5607-9f69-4e12-b0d5-aa0f1a7a94e2).

Utilize links absolutos quando o link aponta para fora da Base dos Dados.

Imagens

Imagens são adicionadas com o elemento Image, ele tem dois campos, src e caption. src é o caminho para imagem que está na pasta next/public/blog/<slug>/.

Exemplo:

<Image src="/blog/analisando-a-frota-brasileira-com-a-bd/image_1.webp" caption="Fonte: Rawpixel"/>

caption é opcional e pode ter link

<Image src="/blog/analisando-a-frota-brasileira-com-a-bd/image_1.webp" caption="Fonte: [Rawpixel](https://www.rawpixel.com/)"/>

Tabelas

| Tables        |      Are      |  Cool |
| ------------- | :-----------: | ----: |
| col 3 is      | right-aligned | $1600 |
| col 2 is      |   centered    |   $12 |
| zebra stripes |   are neat    |    $1 |

Resultado:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

Citação

Citação é feita usando o elemento Blockquote. O atributo caption é opcional e pode ter link, assim como elemento Image

<Blockquote caption="Natália Leão, Diretora de pesquisa e projetos na Gênero e Número.">
Atualmente estamos vivendo um momento importante de mudanças culturais no que se refere ao modo de pensar do brasileiro, aos seus aspectos morais e de valores. Com isso temos conquistado muitos avanços no que tange às desigualdades de gênero e raça, e devemos sempre nos perguntar se essas desigualdades são permanentes ou se tivemos mudanças ao longo dos anos.
</Blockquote>

Embed (Incoporar)

Para incoporar iframes, como vídeos do youtube, twitter ou qualquer outro recurso de terceiros utilize o elemento Emdeb. Ao contrário do elemento Image o código de incorporação é colocado dentro do elemento Embed.

O atributo caption é opcional e pode ter link, assim como Image

<Embed caption="Legenda é opcional">
Código do incoporação aqui
</Embed>

Exemplo para um vídeo do YouTube:

<Embed caption="Alguma descrição para o vídeo, esse campo é opcional">
<iframe width="560" height="315" src="https://www.youtube.com/embed/LlZ0ADyswdQ?si=uTAHzxVjVRNfjtD6" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</Embed>

Enviando para revisão

Ao finalizar a post você precisa comitar e enviar as alterações.

Adicione os arquivos do seu post

git add .

Crie um commit

git commit -m "blogpost: sua mensagem"

Faça o push

git push

Por último abra um pull request. Você precisa ir no reposotório do website da Base dos Dados e cliar em Compare & pull request para criar o PR. Iremos revisar seu post.