service manual

Guias digitais

https://guides.service.gov.au/

Nosso objetivo é fornecer orientações claras, consistentes e convincentes, que inspirarão as equipes e ajudarão a apoiá -las como projetar e fornecer ótimos serviços digitais.

Documentação parcial (layout)

https://govau.github.io/service-manual/docs/

O Cuttlebelle Auto-Docs é implantado na filial gh-pages .

Para atualizar a documentação depois de alterar ou adicionar uma parcial, altere a ramificação gh-pages e execute npm run docs . Pressione para implantar.

Testes de regressão visual

https://github.com/govau/backstop-guides-tests

Isso pode ser executado opcionalmente antes de uma implantação de produção para ver visualmente a diferença.

É bom para alterações não funcionais para garantir que não haja regressão visual.

Ambiente de encenação

• URL : https://service-manual.apps.y.cld.gov.au/
• ramo : develop
• status :

Ambientes de teste (provisionamento automático)

• As filiais implantadas com o sufixo '-staging' serão implantadas para um novo ambiente.
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• Exemplo de ramificação test-staging https://service-manual-test-staging.apps.y.cld.gov.au/

Desenvolvimento

Todas as solicitações de tração devem ser comparadas com develop . Para simplificar as coisas, opte pela opção Docker, mas o DIY também é fornecido. Primeiro, confira o repositório:

 git clone github.com/govau/service-manual
cd service-manual

Opção 1: Docker

Construa a imagem do Docker:

 service-manual$ docker build -t service-manual .

Execute a imagem:

 service-manual$ docker run --rm --volume="$PWD:/workdir" -p 80:8080 -it service-manual

Agora aponte seu navegador para o seu host do Docker com algo como http://localhost/

Opção 2: DIY

É recomendável que você instale nvm para gerenciar sua versão local do nó.

Alterar a versão do nó

nvm use

Instalar dependências

npm install

Construa os ativos estáticos

npm run build

Inicie o servidor de desenvolvimento

npm run watch

Contente

Todo o conteúdo do manual de serviço está na pasta /content . Utilizamos o CuttleBelle como gerador de sites estáticos para separar o conteúdo limpo do layout.

Imagens para páginas de conteúdo podem ser armazenadas na pasta /content/assets .

Metadados

Os metadados podem ser armazenados nas páginas dentro do arquivo index.yml . Todos os campos, exceto pagetitle são opcionais.

Campos

• pagetitle (string required)
  • o título da página
• description (string optional)
  • a meta descrição
• keywords (string, comma delimited list, optional)
  • para mecanismo de pesquisa
• created_by (string optional)
  • é exibido nas páginas usando intro_with_nav
• published_date (ISO date yyyy-mm-dd optional)
  • é exibido nas páginas usando intro_with_nav
  • Certifique-se de se formar como uma string, por exemplo, "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • é exibido nas páginas usando intro_with_nav
  • Certifique-se de se formar como uma string, por exemplo, "2018-05-12"
• boost (integer optional)
  • influencia os resultados do mecanismo de pesquisa
• hidden (boolean optional)
  • esconde a página se definido como true
• weight (integer optional)
  • influencia a ordem dos itens de menu

Mecanismo de pesquisa

A pesquisa é fornecida pelo mecanismo de pesquisa de JavaScript Lunr.

Peso para a pontuação da pesquisa está na seguinte ordem decrescente:

1. keywords (Boost = 30)
2. title (Boost = 10)
3. description (Boost = 5)
4. body (sem impulso)

O conteúdo é indexado no horário de construção e pode ser influenciado com as keywords e boost opcionais dos metadados.

Impulsionar

Use pequenos valores, como 0,5 - 1 até que o resultado da pesquisa desejado seja atingido.

Palavras -chave

As palavras -chave podem ser adicionadas em uma lista delimitada de vírgula.

Páginas federadas

Páginas externas podem ser federadas adicionando dados a scripts/federate.js

Combos especiais

As combinações de palavras especiais de duas palavras podem ser adicionadas para melhorar os resultados para consultas específicas. Um exemplo é o papel 'Gerenciador de entrega'.

Como adicionar uma combinação especial:

1. Anexe a combinação à function specialCombos(query) em 06-search-results.js .
2. Adicione o termo de duas palavras nas palavras -chave da página

Pesquise arquivos estáticos de dados

Os dados e índices de pesquisa são armazenados nos seguintes arquivos estáticos, que são implantados com o site:

1. documents.json (os dados do documento do site)
2. pathmap.json (tabela de pesquisa para o SERP)
3. Search_index.json (índice serializado da LUNR)

Reconstruindo o índice de pesquisa no desenvolvimento

Ao experimentar o ajuste da pesquisa no desenvolvimento, é necessário reconstruir o índice de pesquisa após alterar o conteúdo ou os metadados. Isso pode ser feito quente em outra janela do terminal com o Cuttlebelle funcionando.

 npm run build:search