Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Padroniza documentação básica de repositórios #14

Closed
8 tasks done
trevineju opened this issue Aug 26, 2022 · 4 comments
Closed
8 tasks done

Padroniza documentação básica de repositórios #14

trevineju opened this issue Aug 26, 2022 · 4 comments
Assignees
@trevineju
Labels
docs Melhorias ou complementos à documentação

Comments

@trevineju
Copy link
Member

trevineju commented Aug 26, 2022 •
edited
Loading

A documentação básica de todos os repositórios do Querido Diário devem ter:

  1. Na raiz:
  • LICENSE.md; arquivo de mesmo conteúdo em todos os repositórios
  • Diretório /docs
  1. No diretório /docs conter:
  • CODE_OF_CONDUCT.md e suas traduções; deve apontar para CODE_OF_CONDUCT.md de comunidade
  • FUNDING.yml; arquivo de mesmo conteúdo em todos os repositórios
  • SUPPORT.md e suas traduções; arquivo de mesmo conteúdo em todos os repositórios
  • README.md com layout padronizado e suas traduções
  • CONTRIBUTING.md com layout padronizado e suas traduções; deve apontar para CONTRIBUTING.md de comunidade e conter partes específicas ao repositório

REPOSITÓRIOS COBERTOS
@trevineju trevineju transferred this issue from okfn-brasil/querido-diario-frontend Aug 26, 2022
This was referenced Aug 26, 2022
Closed
Merged
Merged
Merged
Merged
Open
Merged
Open
@trevineju trevineju self-assigned this Aug 26, 2022
@lguima
Copy link
Contributor

lguima commented Sep 6, 2022

oi @trevineju! o arquivo de licença costuma ficar na raiz do repo mesmo

@trevineju
Copy link
Member Author

@lguima obrigada pelo apontamento! Vou corrigir. Aproveitei também pra alimentar a discussão na thread #11 -- que não tinha visto quando abri essa issue. Assim, você e outras pessoas podem complementar os apontamentos de documentação e aí eu sigo trabalhando nesta issue a partir da contribuição de vocês

@trevineju trevineju added the docs Melhorias ou complementos à documentação label Oct 5, 2022
This was referenced Feb 9, 2023
Closed
Closed
@trevineju trevineju mentioned this issue Feb 22, 2023
Closed
8 tasks
trevineju added a commit to okfn-brasil/querido-diario-frontend that referenced this issue Mar 17, 2023
@trevineju
Atualiza arquivos básicos de documentação (#60)
d9ce275 
Buscando se adequar ao padrão de documentação adotado no projeto
(okfn-brasil/querido-diario-comunidade/issues/14), este PR:

- Reorganiza arquivos de documentação para o diretório /docs
- Move e atualiza CODE_OF_CONDUCT.md e sua tradução em inglês.
- Move FUNDING.yml
- Move e atualiza SUPPORT.md e sua tradução em inglês
- Atualiza LICENSE.md
- Padroniza layout do README.md e atualiza seu conteúdo.
- Padroniza layout do CONTRIBUTING.md e atualiza seu conteúdo.
ogecece added a commit to okfn-brasil/querido-diario-toolbox that referenced this issue Aug 3, 2023
@ogecece
Atualiza arquivos básicos de documentação (#45)
65a4e4d 
Buscando se adequar ao padrão de documentação adotado no projeto
(#okfn-brasil/querido-diario-comunidade#14),
este PR:

- Adiciona CODE_OF_CONDUCT.md e sua tradução em inglês. 
- Adiciona FUNDING.yml
- Adiciona SUPPORT.md e sua tradução em inglês
- Atualiza LICENSE.md

- Padroniza layout do README.md e do CONTRIBUTING.md e atualiza seus
conteúdos. Apenas renomeia e move para /.github suas versões em inglês,
mas não as altera (uma vez que a em português seja aprovada, issues para
atualizar a tradução serão abertas)
trevineju added a commit to okfn-brasil/querido-diario-api that referenced this issue Aug 10, 2023
@trevineju
Atualiza arquivos básicos de documentação (#57)
ef087df 
Buscando se adequar ao padrão de documentação adotado no projeto
(#okfn-brasil/querido-diario-comunidade#14), este PR:

- Adiciona CODE_OF_CONDUCT.md e sua tradução em inglês.
- Adiciona FUNDING.yml
- Adiciona SUPPORT.md e sua tradução em inglês
- Atualiza LICENSE.md
- Como não havia CONTRIBUTING.md, o arquivo foi adicionado com layout
padronizado e sua tradução em inglês também.
- Padroniza layout do README.md, modificando pouco o conteúdo que já
existia. Adiciona sua versão em inglês.
trevineju added a commit to okfn-brasil/querido-diario-api-wrapper that referenced this issue Aug 10, 2023
@trevineju
Atualiza arquivos básicos de documentação (#4)
650752a 
Buscando se adequar ao padrão de documentação adotado no projeto
(#okfn-brasil/querido-diario-comunidade#14),
este PR:

- Reorganiza arquivos de documentação para o diretório /docs
- Adiciona CODE_OF_CONDUCT.md e sua tradução em inglês.
- Adiciona FUNDING.yml
- Adiciona SUPPORT.md e sua tradução em inglês
- Atualiza LICENSE.md
- Adiciona CONTRIBUTING.md padronizado e sua tradução em inglês. 
- Padroniza layout do README.md. Adiciona uma versão em inglês
provisória, issues para atualizar a tradução serão abertas.
@trevineju trevineju mentioned this issue Aug 18, 2023
Merged
@ogecece
Copy link
Member

ogecece commented Apr 12, 2024

O querido-diario-infra foi despriorizado e essa issue está completa.

@ogecece ogecece closed this as completed Apr 12, 2024
@robokbr
Copy link
Member

robokbr commented Apr 12, 2024

Traduzindo para inglês | Translating to english

Dear-diario-infra has been deprioritized and this issue is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@trevineju trevineju

Labels
docs Melhorias ou complementos à documentação
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lguima @ogecece @robokbr @trevineju