2 544
edições
Sem resumo de edição |
m (Peter moveu Documentação dos sites para web:Documentação dos sites: novo prefixo web:site, expandindo site) |
||
(15 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
Linha 1: | Linha 1: | ||
'''Documentação da arquitetura e requisitos gerais dos sites''' do [[ITGS]], válidas para o próprio ''site ITGS'' e todos os ''sites de projetos'' encubados. | [[Arquivo:Site-illustre2.png|direita|semmoldura]] | ||
'''Documentação da arquitetura e requisitos gerais dos sites''' do [[ITGS]], válidas para o próprio ''site ITGS'' e todos os ''sites de projetos'' encubados. Conceito: | |||
: Sites, domínios e ''web services''. [[wikipedia:Website|Websites]], como coleção de páginas identificadas por um mesmo [[wikipedia:domain name|nome de domínio]], publicadas em um [[wikipedia:web server|servidor web]]. Nos mesmos servidores e domínios são implantados os [[wikipedia:Communication endpoint|''endpoints'']] dos [[wikipedia:Microservices|''microservices'']]. | |||
Em uso nos seguintes sites, com diferenças e nuanças descritas nas respectivas documentações: | Em uso nos seguintes sites, com diferenças e nuanças descritas nas respectivas documentações: | ||
* | * {{ns-xref|site|A4A}}: documentação do site do [[A4A|projeto A4A]], a ser implantado em [https://AdressForAll.org <code>AdressForAll.org</code>]. | ||
* | * {{ns-xref|site|OSMC}}: documentação do site do [[OSMC|projeto OSMC]], a ser implantado em [https://OSM.codes <code>OSM.codes</code>]. | ||
* | * {{ns-xref|site|DG}}: documentação do site do [[DG|projeto DG]], a ser implantado em [https://Digital-guard.org <code>Digital-guard.org</code>]. | ||
Sites e diretivas para serviços de uso geral: | |||
* {{ns-xref|site|ITGS}}: documentação do site do próprio [[ITGS|ITGS]], a ser implantado em [https://ITGS.org.br <code>ITGS.org.br</code>] (conteúdo guarda-chuva), com parte principal sob a marca <code>AdressForAll.org</code>. | |||
* {{ns-xref|site|WS}}: diretivas e requisitos gerais para a implementação de web services. | |||
* {{ns-xref|site|Wiki}}: esta Wiki de documentação técnica, suas diretivas, requisitos e backups. | |||
* {{ns-xref|site|Gits}}: repositórios ''git'' (com conteúdo mínimo em README - apontando para a Wiki) e sites de ''git-hosting'', diretivas sobre redirecionamento dos sub-domínios <code>git.dominio</code>, <code>git-site.dominio</code> e <code>git-raw.dominio</code>. | |||
== Escopo e objetivos == | |||
Um mesmo site pode satisfazer diferentes objetivos, mas todos eles previstos na presente documentação: | |||
* Publicação de '''conteúdo "institucional do projeto"''': devido à previsão [http://addressforall.org/en/statutes/ estatutária] de [[wikipedia:Corporate spin-off|spin-off]] dos projetos, eles adquirem conteúdo institucional na sua "versão 1.0". Fazem parte do conteúdo institucional: | |||
** O Estatuto (projeto ou ITGS), sua apresentação e documentos de transparência (incluindo prestação de contas e relatórios de produtividade institucional). | |||
** A apresentação institucional geral, incluindo descrição dos membros/responsáveis, páginas de descrição e acesso aos recursos (ex. ''downloads'' oficiais), produtos e serviços. | |||
* Publicação de '''dados e sua visualização''': relatórios, gráficos, tabelas, mapas, buscas, etc. estáticos e interativos. | |||
* Intranet e '''acesso controlado''': ferramentas e conteúdos internos, acessíveis apenas mediante autenticação. | |||
* '''''Web services''''': serviços de assistência à visualização, à consulta de banco de dados, e ao controle do sistema (intranet). | |||
* '''Documentação técnica''': todos os conteúdos técnicos (para programadores e demais especialistas) e tutoriais, em Wiki do tipo Mediawiki (que implementa a Wikipedia). | |||
O objetivo do site é a publicação do conteúdo, a experiência do usuário, e a promoção de um ecossistema de ferramentas utilizáveis e interoperáveis, suportando requisitos e casos de uso maduros e definidos por consenso dentro do ITGS. | |||
== Pilares filosóficos == | == Pilares filosóficos == | ||
Linha 17: | Linha 45: | ||
#* Transparente para a [[wikipedia:Semantic Web|Web Semântica]], conforme [https://github.com/okfn-brasil/lexml-dou LexML-DOU] e [[wikipedia:Journal Article Tag Suite|padrão JATS]]. | #* Transparente para a [[wikipedia:Semantic Web|Web Semântica]], conforme [https://github.com/okfn-brasil/lexml-dou LexML-DOU] e [[wikipedia:Journal Article Tag Suite|padrão JATS]]. | ||
# '''Princípios''' básicos: [[wikipedia:Occam's razor|Simplicidade Zen]], [[wikipedia:Separation of concerns|"Separação das responsabilidades"]] e [[wikipedia:Convention over configuration|"Convenção sobre configuração"]]. | # '''Princípios''' básicos: [[wikipedia:Occam's razor|Simplicidade Zen]], [[wikipedia:Separation of concerns|"Separação das responsabilidades"]] e [[wikipedia:Convention over configuration|"Convenção sobre configuração"]]. | ||
# Organização e distribuição dos ''endpoints'' e ''microservices'' conforme [[wikipedia:Data mesh|filosofia '''Data Mesh''']]. Portanto exposição, visualização e publicação dos dados nos sites deve ter seu [[wikipedia:Domain-driven design|desenho guiado por domínio]]. | |||
== Arquitetura e reuso do sistema == | == Arquitetura e reuso do sistema == | ||
[[file:TempEngWeb016. | [[file:TempEngWeb016-v2.png|thumb|180px|Sistemas de ''template'': o [[wikipedia:Template processor|''template engine'']] (processador) é alimentado pelos ''dados'' e o ''template'' mais adequado à visualização do tipo de dado.]] | ||
Os principais aspectos da arquitetura são relativos: ao [[wikipedia:Web template system|''sistema de template'']] (ilustrado) e aos | Os principais aspectos da arquitetura são relativos: ao [[wikipedia:Web template system|''sistema de template'']] (ilustrado) e aos microsserviços ([[wikipedia:Web service|''web services'']]). | ||
O pilar da transparência levou à arquitetura diferenciada na publicação do conteúdo: | O pilar da transparência levou à arquitetura diferenciada na publicação do conteúdo: | ||
* Conteúdo institucional via arquitetura "Outside server template system" (preferível) ou "Server-side template system". | * Conteúdo institucional via arquitetura "Outside server template system" (preferível) ou "Server-side template system". | ||
* O restante opcional, pode fazer também uso de "Client-side template system". Tipicamente a navegação intranet, depois do ''login'' seria client-side. | *O restante opcional, pode fazer também uso de "Client-side template system". Tipicamente a navegação intranet, depois do ''login'' seria client-side. | ||
A arquitetura ''"Outside server template system"'', na prática, é implementada como ''cache'' da ''Server-side''. A ''client-side'' é sempre implementada através de Javascript, fazendo uso principalmente do [[wikipedia:Document Object Model|DOM]] (''Document Object Model'') na geração dinâmica de conteúdo, e usando a CPU do usuário final para isso. O ''template'' e ''inputs'' do ''client-side'' podem ter origem tanto ''server-side'' como em ''outside server''. | |||
<gallery widths="240px" class="center"> | |||
File:StaticTemplates.gif|'''''Outside server''' template system''. | |||
File:ServerSideTemplates.gif|'''''Server-side''' template system''. | |||
File:ClientSideTemplates.gif|'''''Client-side''' template system''. | |||
</gallery> | |||
''Microservices'' e seus ''endpoints'', bem como [[wikipedia:URL redirection|redirecionamentos]] e estrutura de roteamento entre sites, são primariamente gerenciadas por [[wikipedia:NGINX|'''NGINX''']]. Na arquitetura do sistema, o papel principal do NGINX é de [[wikipedia:Reverse proxy|''proxy'' reverso]]: | |||
[[File:Reverse proxy h2g2bob-renderized.png|center|320px]] | |||
Nota. Cabe ao roteamento ReactJS apenas a gestão dos respectivos sites. | |||
== | ==Frameworks e gestão de conteúdo== | ||
... | Foram tomadas as seguintes '''decisões de projeto para a construção de todos os sites''': | ||
* Conteúdo de '''documentação técnica''' em [[wikipedia:Mediawiki|Mediawiki]]: todos na <code>wiki.addressforall.org</code>, separando-se cada projeto através de ''namespaces''. | |||
* Conteúdo '''institucional gerado como HTML estático''' por [[wikipedia:Server-side scripting|''server-side building'']], com tecnologia [[wikipedia:Next.js|NextJS]]. | * Conteúdo '''institucional gerado como HTML estático''' por [[wikipedia:Server-side scripting|''server-side building'']], com tecnologia [[wikipedia:Next.js|NextJS]]. | ||
** publicado como [https://github.com/okfn-brasil/HTML5-onlyContent HTML5-onlyContent] e com interpretações visual (usuário humano) e robótica (marcação semântica) baseadas na mesma única fonte de verdade, conforme [https://github.com/okfn-brasil/lexml-dou LexML-DOU] dos diários oficiais. <br/>Ou seja: não replicar em JSON ou Javascript, aplicar a marcação semântica diretamente ao conteúdo HTML visualizado. | |||
* Conteúdo institucional, visualização de dados, intranet e relatórios públicos: tecnologia [[wikipedia:React (software)|'''ReactJS''']] em ''server-side'' e ''client-side''. | * Conteúdo institucional, visualização de dados, intranet e relatórios públicos: tecnologia [[wikipedia:React (software)|'''ReactJS''']] em ''server-side'' e ''client-side''. | ||
== | * Na visualização de dados, no client-side: | ||
** Para dados tabulares, ''framework React'' com poder similar a [https://datatables.net/ DataTables] ou [https://tabulator.info/docs Tabulator]. | |||
** Para visualização matemática, estatística etc., preferência por ''framework React'' que reconheça descrição gráfica JSON na linguagem [https://vega.github.io/vega-lite/ VEGA-Lite]. | |||
** Para visualização geográfica, preferência por ''framework React'' garanta o integração com [[wikipedia:OpenLayers|'''OpenLayers''']]. | |||
* Conteúdo '''multilingual''': | |||
** Institucional e visualização: recursos nativos, ReactJS ou NextJS. | |||
** Documentação técnica: na Mediawiki estabelecer referencial de estilo, provavelmente [https://wiki.openstreetmap.org wiki.openstreetmap.org]. | |||
* [[wikipedia:Single-page application|Single-page]] ''vs'' multiple-page sites: preferência por ''multiple-page'' apenas no conteúdo institucional (estático). | |||
=== Modelo Apache === | |||
[[Arquivo:Site-temaApache-v1.png|miniaturadaimagem|Modelo de "página do projeto" do [https://ranger.apache.org/ Apache Ranger]. Já no meno superior e na página de apresentação os links de documentação remetem à Wiki. Além dos itens básicos, um dos itens de menu remete ao "guarda-chuva encubador" (site Apache Foundation). A identidade visual é preservada.]] | |||
A [[wikipedia:The Apache Software Foundation|Apache Foundation]] foi eleita como modelo de referência para a organização dos projetos: cada projeto tem seu próprio domínio ou subdomínio, e cada projeto tem um ''namespace'' na "Wiki de documentação global dos projetos". | |||
== Temas e identidade visual == | |||
... Enquanto um projeto não tem CNPJ próprio, deve respeitar tema e estilos ITGS. | |||
[[Categoria: | ... A identidade visual, principalmente cores e logotipos, deve respeitar o Guia e Identidade visual ITGS. Os logotipos de projetos podem permanecer ao lado do logo A4A sempre a navegação for restrita ao projeto. | ||
[[Categoria:Sites|*Documentação dos sites]] |
edições