Discussão:Projeto Cuidando do Meu Bairro
- Reunir documentação iniciada em https://gitlab.com/ok-br/cuidando2/wikis/home e outras partes
- Listar webservices e geração de dados do Dados Abertos que possuem dependencias.
- Revisar histórico de contratos (Gastos Abertos e Cuidando2) e "inspirações" (Cuidando1, Mostre e outros).
Proposta fora de uso
editarO domínio cuidando.vc possuirá os links principais da documentação na forma de PURL.
| PURL | URL | Comentário |
|---|---|---|
www.cuidando.vc/docs/dev/ws
|
... | Texto geral de introdução aos webservices do Cuidando. |
ws.cuidando.vc/docs
|
http://www.cuidando.vc/docs/dev/ws | Se houver um subdominio para os webservices (ws), o /docs dele já seria redirecionado para o site oficial da documentação. |
www.cuidando.vc/docs/dev/ws/viralata-cuidando
|
https://github.com/okfn-brasil/viralata/blob/master/README.md | ... |
ws.cuidando.vc/viralata-cuidando/howto
|
https://viralata-cuidando.rhcloud.com | Lista dos comandos (REST por POST/GET/PUT) com breve descrição e interface para teste. |
Resumo da proposta:
cuidando.vc/docs: texto com link para o "Guia do desenvolvedor", e demais documentações ou tutoriais.
ws.cuidando.vc: webservices, texto de apresentação e links para /howto e /docs
ws.cuidando.vc/docs: lista todos os docs's de webservices disponíveis.
ws.cuidando.vc/nome_webservice/docs: "guia" sintético para os usuários (técnicos) do webservice designado, com link (ou direto o redirecionamento) para a documentação completa do webservice.
ws.cuidando.vc/howto: lista todos os howto's de webservices disponíveis.
ws.cuidando.vc/nome_webservice/help: "How to" sintético para os usuários (técnicos) do webservice designado (conformenome_webservice). Exemplo de uso com GET:ws.cuidando.vc/viralata/help/login/external/manual/{backend}
Outros projetos
editarAvaliar e relacionar... Exemplos:
- FiscalizeAgora.org (criado em junho de 2015 e operações tralvez à mesma época que o Cuidando ou mais tarde) parece usar examente os mesmos dados e abordagens, vale a pena convidar para unificar o back-end. Problema: parece ser uma iniciativa privada, sem um coletivo aberto no desenvolvimento e sem possibilidade de auditoria sobre o sistema.
- ...