dg:Readme automatizado: mudanças entre as edições
(Criou página com '== Readme automatizado == Template em ptbr: https://github.com/digital-guard/preserv/blob/main/src/maketemplates/readme_ptbr.mustache Template em es: https://github.com/digital-guard/preserv/blob/main/src/maketemplates/readme_es.mustache A seguir exemplo fictício de make_conf.yaml para gerar um README.md do pacote. Reparar nas chaves: <code>comments, comment, test_evidence, standardized_fields, other_fields, other_files e to-do</code>. Informações extras ou que n...') |
Sem resumo de edição |
||
Linha 79: | Linha 79: | ||
* https://github.com/digital-guard/preserv-BR/tree/main/data/SP/Atibaia/_pk0021.01 | * https://github.com/digital-guard/preserv-BR/tree/main/data/SP/Atibaia/_pk0021.01 | ||
* https://github.com/digital-guard/preserv-BR/tree/main/data/ES/CachoeiroItapemirim/_pk0091.01 | * https://github.com/digital-guard/preserv-BR/tree/main/data/ES/CachoeiroItapemirim/_pk0091.01 | ||
[[Categoria:Digital-guard]] |
Edição das 23h09min de 1 de maio de 2023
Readme automatizado
Template em ptbr: https://github.com/digital-guard/preserv/blob/main/src/maketemplates/readme_ptbr.mustache
Template em es: https://github.com/digital-guard/preserv/blob/main/src/maketemplates/readme_es.mustache
A seguir exemplo fictício de make_conf.yaml para gerar um README.md do pacote. Reparar nas chaves: comments, comment, test_evidence, standardized_fields, other_fields, other_files e to-do
.
Informações extras ou que não se encaixam nas referidas chaves devem ser incluídas num arquivo attachment.md, que terá seu conteúdo anexado ao final do README.md numa seção chamada anexo.
pack_id: 81.1
pkversion: 001
schemaId_input:
schemaId_template:
codec:descr_encode: srid=31983
files:
-
p: 1
file: d9cddc63f7782d250fc80f0572b9fb884ee7ec1911e19deea4381a4ad5d0a172.zip
name: Bairros
comments: Comentários sobre o arquivo, se houver.
size: 1234
layers:
geoaddress:
subtype: ext
method: shp2sql
file: 1
sql_select: ['gid', 'numnovo as hnum', 'cod_log', 'geom']
orig_filename: pg_renumeracoes
comments: Comentários referente ao layer, se houver.
test_evidence: endereço da imagem de evidencia do layer.
# dados relevantes, padronizados
standardized_fields:
-
name: nome do campo ou combinação de campos
standard: 'nome padronizado, por exemplo: hnum'
comment: comentários sobre o campo, se houver.
# dados relevantes, NÃO padronizados, se houver
other_fields:
-
name: nome do campo ou combinação de campos
comment: comentários sobre o campo, se houver.
comments: Comentários gerais sobre os dados, sobre o pacote, etc, se houver.
test_evidence: endereço da imagem de evidencia de todos os dados.
# outros arquivos que podem ser úteis
other_files:
-
p: 2
file: pg_div_municipio.zip
name: pg_div_municipio
format: shp
comment: Arquivo com a divisa territorial de guarulhos e vizinhos.
# Lista de tarefas
to-do:
- Tarefa 1.
Como gerar
Exemplo de geração de README.md:
pushd /var/gits/_dg/preserv-BR/src make all pushd /var/gits/_dg/preserv-BR/data/AC/RioBranco/_pk0042.01 make readme pg_db=ingest99 popd popd
Exemplos:
- https://github.com/digital-guard/preserv-BR/tree/main/data/SP/SaoPaulo/_pk0033.01
- https://github.com/digital-guard/preserv-BR/tree/main/data/AC/RioBranco/_pk0042.01
- https://github.com/digital-guard/preserv-BR/tree/main/data/SP/Atibaia/_pk0021.01
- https://github.com/digital-guard/preserv-BR/tree/main/data/ES/CachoeiroItapemirim/_pk0091.01