service manual

Guías digitales

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

Nuestro objetivo es proporcionar una guía clara, consistente y convincente que inspire a los equipos y ayude a apoyarlos con cómo diseñar y ofrecer excelentes servicios digitales.

Documentación parcial (diseño)

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

Los cutlebelle Auto-Docs se implementan en la sucursal gh-pages .

Para actualizar la documentación después de cambiar o agregar un parcial, cambie a la rama gh-pages y ejecute npm run docs . Empujarlo para implementar.

Pruebas de regresión visual

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

Estos se pueden ejecutar opcionalmente antes de una implementación de producción para ver visualmente la diferencia.

Es bueno para los cambios no funcionales para garantizar que no haya regresión visual.

Entorno de puesta en escena

• URL : https://service-manual.apps.y.cld.gov.au/
• Rama : develop
• estado :

Entornos de prueba (aprovisionamiento automático)

• Las ramas implementadas con el sufijo '-etapa' se implementarán en un nuevo entorno.
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• Ejemplo test-staging de rama https://service-manual-test-staging.apps.y.cld.gov.au/

Desarrollo

Todas las solicitudes de extracción deben compararse con develop . Para mantener las cosas simples, opte por la opción Docker, pero también se proporciona el bricolaje. Primero mira el repositorio:

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

Opción 1: Docker

Construye la imagen Docker:

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

Ejecute la imagen:

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

Ahora apunte su navegador a su host de Docker con algo como http://localhost/

Opción 2: DIY

Se recomienda instalar nvm para administrar su versión de nodo local.

Cambiar la versión del nodo

nvm use

Instalar dependencias

npm install

Construir los activos estáticos

npm run build

Iniciar el servidor de desarrollo

npm run watch

Contenido

Todo el contenido para el manual de servicio está en la carpeta /content . Utilizamos Cuttlebelle como generador de sitios estático para separar limpiamente el contenido del diseño.

Las imágenes para las páginas de contenido se pueden almacenar en la carpeta /content/assets .

Metadatos

Los metadatos se pueden almacenar en páginas dentro del archivo index.yml . Todos los campos excepto pagetitle son opcionales.

Campos

• pagetitle (string required)
  • el título de la página
• description (string optional)
  • la meta descripción
• keywords (string, comma delimited list, optional)
  • para el motor de búsqueda
• created_by (string optional)
  • se muestra en páginas usando Intro_With_Nav
• published_date (ISO date yyyy-mm-dd optional)
  • se muestra en páginas usando Intro_With_Nav
  • Asegúrese de formarse como una cadena, por ejemplo, "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • se muestra en páginas usando Intro_With_Nav
  • Asegúrese de formarse como una cadena, por ejemplo, "2018-05-12"
• boost (integer optional)
  • influye en los resultados del motor de búsqueda
• hidden (boolean optional)
  • Oculta la página si se establece en verdadero
• weight (integer optional)
  • influye en el pedido de los elementos del menú

Motor de búsqueda

La búsqueda es proporcionada por el motor de búsqueda de Lunr JavaScript.

El peso para la puntuación de búsqueda está en el siguiente orden descendente:

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

El contenido está indexado en el tiempo de compilación y puede influir en las keywords y boost de los campos de metadatos opcionales.

Aumentar

Use valores pequeños, como 0.5 - 1 hasta que se alcance el resultado de la búsqueda deseado.

Palabras clave

Las palabras clave se pueden agregar en una lista delimitada de coma.

Páginas federadas

Las páginas externas pueden federarse agregando datos a scripts/federate.js

Combos especiales

Se pueden agregar combinaciones de palabras especiales de dos palabras para mejorar los resultados de consultas específicas. Un ejemplo es el rol 'Gerente de entrega'.

Cómo agregar un combo especial:

1. Agregue la combinación a la function specialCombos(query) en 06-search-results.js .
2. Agregue el término de dos palabras a las palabras clave de la página

Buscar archivos estáticos de datos

Los datos de búsqueda y los índices se almacenan en los siguientes archivos estáticos, que se implementan con el sitio:

1. Documents.json (los datos del documento del sitio)
2. Pathmap.json (tabla de búsqueda para el SERP)
3. Search_index.json (índice serializado de LUNR)

Reconstruir el índice de búsqueda en el desarrollo

Al experimentar con el ajuste de búsqueda en el desarrollo, es necesario reconstruir el índice de búsqueda después de cambiar contenido o metadatos. Esto se puede hacer caliente en otra ventana terminal con Cuttlebelle corriendo.

 npm run build:search