culturagovbr / mapasculturais_descontinuado

Mapas Culturais
16 stars 2 forks source link

Melhorar documentação técnica e incluir documentação para usuário #33

Open intrepidocabral opened 8 years ago

intrepidocabral commented 8 years ago

Documentação técnica para desenvolvedor:

Documentação de uso da ferramenta (para usuário final):

leogermani commented 7 years ago

documentação tecnica de como inserir metadados eu fiz;

http://docs.mapasculturais.org/mc_developer_theme_add_metadata/

Essa documentação de inserir itens na taxonomia eu queria conversar junto pra ver como está talvez mudar algo

avaloni commented 7 years ago

Habilitar e desabilitar entidades

Adicionado em https://github.com/culturagovbr/mapasculturais/blob/rc/documentation/docs/mc_developer_entities.md

Documentar como inserir novos metadados

O @leogermani já havia feito: https://github.com/culturagovbr/mapasculturais/blob/rc/documentation/docs/mc_developer_theme_add_metadata.md

Documentar inserção de itens na taxonomia

Criei um novo arquivo: https://github.com/culturagovbr/mapasculturais/blob/rc/documentation/docs/mc_developer_theme_add_taxonomies.md

Habilitação e desabilitação de plugins

Já existe: https://github.com/culturagovbr/mapasculturais/blob/rc/documentation/docs/mc_config_plugins.md

Documentar como criar e utilizar hooks

Eu incluí a criação de hooks nesse arquivo porque ele já tinha a explicação de como utilizar

Documentação de uso da ferramenta (para usuário final)

Não consegui encontrar o manual atual em PDF

diegodorgam commented 7 years ago

@rafaelchavesfreitas por gentileza verificar onde está o manual em PDF dos usuários

rafaelchavesfreitas commented 7 years ago

@diegodorgam o arquivo original é este: https://github.com/hacklabr/mapasculturais/blob/master/src/protected/application/themes/BaseV1/assets/mapasculturais_manual.odp Mas alguns temas tem seu próprio arquivo com os screens de acordo com as cores do tema.

vitor-kato commented 7 years ago

Ainda há pendências aqui não?

diegodorgam commented 7 years ago

sim @vitor-kato, é isso mesmo. estamos priorizando no board, https://github.com/culturagovbr/mapasculturais/projects/1