Skip to content

fzans/brasil.gov.portal

 
 

Repository files navigation

.gov.br: Portal Padrão da Identidade Digital do Governo

Conteúdo

Introdução

Este pacote provê configurações para implementação da Identidade Digital de Governo em sites Plone do Governo da República Federativa do Brasil.

O desenvolvimento deste pacote foi feito como parte da iniciativa Portal Padrão da comunidade PloneGov.Br.

Requisitos

Para uso deste pacote, seu site deve ter sido construído com:

Recomendamos a leitura do documento sobre a instalação deste pacote.

Estado deste pacote

O brasil.gov.portal tem testes automatizados e, a cada alteração em seu código os testes são executados pelo serviço Travis.

O estado atual dos testes, a cobertura de código e o número de downloads deste pacote podem ser vistos nas imagens a seguir:

image

image

image

image

Instalação

Para habilitar a instalação deste produto em um ambiente que utilize o buildout:

  1. Editar o arquivo buildout.cfg (ou outro arquivo de configuração) e adicionar o pacote brasil.gov.portal à lista de eggs da instalação:

    [buildout]
    ...
    eggs =
        brasil.gov.portal
  2. Editar o arquivo buildout.cfg (ou outro arquivo de configuração) referenciando o uso do versions.cfg de acordo com o release presente em portalpadrao.release
  3. Após alterar o arquivo de configuração é necessário executar ''bin/buildout'', que atualizará sua instalação.
  4. Reinicie o Plone
  5. Adicione um novo site Plone.

Rodando o buildout de uma tag antiga do pacote

Para atender ao relato de ter vários jobs de integração contínua em pacotes brasil.gov.* (ver plonegovbr/portalpadrao.release#11), no fim da seção extends do buildout.cfg de todos os pacotes brasil.gov.* temos a seguinte linha:

https://raw.githubusercontent.com/plonegovbr/portal.buildout/master/buildout.d/versions.cfg

Hoje, esse arquivo contém sempre as versões pinadas de um release a ser lançado. Por esse motivo, quando é feito o checkout de uma tag mais antiga provavelmente você não conseguirá rodar o buildout. Dessa forma, após fazer o checkout de uma tag antiga, recomendamos que adicione, na última linha do extends, o arquivo de versões do IDG compatível com aquela tag, presente no repositório https://github.com/plonegovbr/portalpadrao.release/.

Exemplo: você clonou o repositório do brasil.gov.portal na sua máquina, e deu checkout na tag 1.0.5. Ao editar o buildout.cfg, ficaria dessa forma, já com a última linha adicionada:

extends =
    https://raw.github.com/collective/buildout.plonetest/master/test-4.3.x.cfg
    https://raw.github.com/collective/buildout.plonetest/master/qa.cfg
    http://downloads.plone.org.br/release/1.0.4/versions.cfg
    https://raw.githubusercontent.com/plonegovbr/portal.buildout/master/buildout.d/versions.cfg
    https://raw.githubusercontent.com/plone/plone.app.robotframework/master/versions.cfg
    https://raw.githubusercontent.com/plonegovbr/portalpadrao.release/master/1.0.5/versions.cfg

Para saber qual arquivo de versões é compatível, no caso do brasil.gov.portal, é simples pois é a mesma versão (no máximo um bug fix, por exemplo, brasil.gov.portal é 1.1.3 e o arquivo de versão é 1.1.3.1). Para os demais pacotes, recomendamos comparar a data da tag do pacote e a data nos changelog entre uma versão e outra para adivinhar a versão compatível.

Sobrescrita de traduções do domínio plone

Se você tem um produto que tem como dependência o brasil.gov.portal e precisa sobrescrever traduções do domínio plone nesse produto, sua diretiva `<i18n:registerTranslations directory="locales" /> deve vir antes da diretiva <includeDependencies package="." />`, ou de qualquer outra diretiva que carrege o ZCML do brasil.gov.portal. O seu configure.zcml deve ficar assim:

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:five="http://namespaces.zope.org/five"
    xmlns:i18n="http://namespaces.zope.org/i18n"
    i18n_domain="meu.produto">

  <i18n:registerTranslations directory="locales" />

  <includeDependencies package="." />

  ...

</configure>

O ZCML do brasil.gov.portal carrega o ZCML do Products.CMFPlone, que por sua vez carrega o ZCML do plone.app.locales. Assim o locales do seu produto precisa ser carregado antes do ZCML do brasil.gov.portal para que as traduções do seu produto possam sobrescrever às do Plone.

About

Implementação em Plone do Portal Padrão da Identidade Digital de Governo

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 60.3%
  • CSS 29.4%
  • JavaScript 5.4%
  • RobotFramework 4.9%