Auxilium Humanitarium API documentōrum ^(alpha)

Praefātiōnem

1. ❓🌐 https://hapi.etica.ai/ 🌐❓
   1. ❗ https://github.com/HXL-CPLP/hapi.etica.ai ❗
      1. ❗ https://github.com/HXL-CPLP/Auxilium-Humanitarium-API/actions ❗
         1. ❗.github/workflows/05-deploy-github-pages.yml ❗
            1. ❗https://github.com/HXL-CPLP/Auxilium-Humanitarium-API ❗
            2. ❗docs.google.com: HXL-CPLP-Vocab_Auxilium-Humanitarium-API❗
               1. 🆘 https://support.google.com/docs/answer/6000292 🆘
2. ❓🔤 https://hapi.etica.ai/por-Latn/ 🔤❓
   1. ❗ GitHub.com: documentum/por-Latn/ ❗
   2. ❗ docs.google.com:: HXL-CPLP-Vocab_Auxilium-Humanitarium-API❗
3. ❓🔤 https://hapi.etica.ai/eng-Latn/ 🔤❓
   1. ❗ GitHub.com: documentum/eng-Latn/ ❗
      1. ❗ docs.google.com: HXL-CPLP-Vocab_Auxilium-Humanitarium-API❗

@TODO: [por] adicionar mais links

English

Note to maintainers in English

• https://translate.google.com/translate?sl=pt&tl=en&u=https://github.com/HXL-CPLP/Auxilium-Humanitarium-API/blob/main/README.md

Español

Nota para mantenedores en español

• https://translate.google.com/translate?sl=pt&tl=es&u=https://github.com/HXL-CPLP/Auxilium-Humanitarium-API/blob/main/README.md

Português

Seja uma pessoa bem vinda ao projeto Documentação interativa para APIs humanitárias!

Neste momento, 2021-05-16, este projeto está em fase de desenvolvimento alfa e, ainda que o site hapi.etica.ai possa ser usado pelo publico final, não há documentação em como aceitar colaboração externa. Se você já não foi convidado por algum de nossos membros e tem nosso contato direto, por favor entre em contato por e-mail, Facebook, WhatsApp, LinkedIn ou o que for com membros do HXL-CPLP.

Introdução rápida

• Site público: https://hapi.etica.ai/
• GitHub, código fonte: https://github.com/HXL-CPLP/Auxilium-Humanitarium-API
• GitHub, código fonte de hapi.etica.ai: https://github.com/HXL-CPLP/hapi.etica.ai
• Fontes de dados externas:
  • docs.google.com: HXL-CPLP-Vocab_Auxilium-Humanitarium-API

Executar o Jekyll localmente

Configuração inicial (apenas uma vez): obter cópia e instalar dependências

• Como clonar repositório?
  • https://docs.github.com/pt/repositories/creating-and-managing-repositories/cloning-a-repository
• Como instalar dependências do bundler?
  • https://bundler.io/

# Existem pelo menos 3 formas de clonar o repositório. Esta não requer
# configurar credenciais de acesso. Você talvez queria criar próprio fork
git clone https://github.com/HXL-CPLP/Auxilium-Humanitarium-API.git
cd Auxilium-Humanitarium-API

# Como instalar Ruby e o Bundler: não explicado aqui

# Uma das formas de definir onde ficariam instaladas as dependências
bundle config set path 'vendor/bundle'

# Instala, de fato, as dependências
bundle install

Dia a dia: executar versão local

JEKYLL_ENV=development bundle exec jekyll serve --config _config.yml,_config_dev.yml

# JEKYLL_ENV=development bundle exec jekyll serve --incremental
# Server address: http://127.0.0.1:4000/

## Debug
JEKYLL_ENV=development bundle exec jekyll serve --config _config.yml,_config_dev.yml --trace --watch

## Velocidade
bundle exec jekyll serve --config _config.yml,_config_dev.yml --profile

Tópico especial: de onde "vem os dados do site"?

Resposta curta

Se você estiver fazendo um clone local, ele usará tanto arquivos YAML (que são projetados para ser editados usando git) como arquivos HXLizados que contém as traduções.

Caso você queira ajudar com traduções, por favor, entre em contato com mantenedores que explicamos a você.

Resposta para pessoas mantenedoras

Ao usar bundle exec jekyll serve os arquivos de dados locais funcionam como um tipo de cacheamento (bem como um implicitamente um histórico), porém pessoas colaboradoras (mesmo que não sejam quem cria as traduções, mas sim os YAMLs) também tem acesso de edição nas planilhas.

O arquivo Rakefile tem atalhos para algumas rotinas comuns do utilitário de linha de comando rake (veja https://ruby.github.io/rake/).

### Roda as tarefas padrões (exceto testes e limpeza de cache local)
# No mínimo irá baixar todas as planilhas que são editadas colaborativamente
# por humanos no GSheets.
rake

### Roda testes (exemplo: checagem de links quebrados)
rake test

### Deleta caches intermediários
# Como o site é executado DUAS vezes antes de estar pronto (isto é, na primeria
# vez que o site é executado, se não houver cache, ele pede para rodar de novo)
# Existe situação onde quem trabalhar localmente pode ter um cache
# intermediário que impede terminar o ciclo. O comando a seguir limpa esses
# arquivos
rake purgatorium

Tópico especial: planilhas foram alteradas, mas não precisa editar códigos e YAML. O que fazer para atualizar o hapi.etica.ai?

Vá em https://github.com/HXL-CPLP/Auxilium-Humanitarium-API/actions, encontre um teste qualquer recente e clique "Re-run all jobs".

O .github/workflows/05-deploy-github-pages.yml é instruído a sempre baixar arquivos das planilhas online e ignorar os caches salvos no GitHub.

Voluntarius Auxilio Tuo

• _data/agnitionem/humanum.yml

- nomen:
    abecedariam: Latn
    baptismum: Thalles Augusto
  opus:
    - fundatarem
  picturam: https://avatars.githubusercontent.com/u/61105850?v=4
  iri: https://github.com/ThesllaDev
  github: https://github.com/ThesllaDev
  linkedin: https://www.linkedin.com/in/thalles-augusto/

- nomen:
    abecedariam: Latn
    baptismum: Emerson Rocha
  opus:
    - fundatarem
  picturam: https://avatars.githubusercontent.com/u/812299?v=4
  iri: https://github.com/fititnt
  github: https://github.com/fititnt
  linkedin: https://www.linkedin.com/in/fititnt/

- nomen:
    abecedariam: Latn
    baptismum: Sine nomine (multis clanculum civibus)
    translatianem:
      Arab:
      Cyrl:
      Hans:
      # Latn:
  opus:
    - translationem
    - commanitatem-auxilium
  picturam: https://avatars.githubusercontent.com/u/50434491?v=4
  iri: https://github.com/eticaaibot
  github:
  gitee:
  linkedin:

Licentiam

Licentiam: Dominium publicum.