turicas/brasil.io

Gerar documentação da API automaticamente

Open

#204 opened on Apr 9, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (150 forks)github user discovery
help wanted

Repository metrics

Stars
 (1,032 stars)
PR merge metrics
 (PR metrics pending)

Description

Tudo o que precisamos para gerar automaticamente a documentação da API, por tabela, está no banco, nos models Dataset, Version, Table e Field. A documentação da API pode ser uma página dentro do próprio Brasil.IO, com uma descrição geral do dataset e um índice por tabela, bem parecida com a documentação (feita manualmente) do dataset covid19.

Contributor guide

Research direction
Examine the models Dataset, Version, Table, and Field to extract metadata, then generate a page similar to the existing manual documentation for covid19.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70