service manual

Guides numériques

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

Nous visons à fournir des conseils clairs, cohérents et convaincants qui inspireront les équipes et aideront à les soutenir sur la façon de concevoir et de fournir d'excellents services numériques.

Documentation partielle (mise en page)

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

Les Auto-Docs de CuttleBelle sont déployés dans la branche gh-pages .

Pour mettre à jour la documentation après avoir modifié ou ajouté une partie partielle, passez à la branche gh-pages et exécuté npm run docs . Poussez-le au déploiement.

Tests de régression visuelle

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

Ceux-ci peuvent être éventuellement exécutés avant un déploiement de production pour voir visuellement la différence.

Il est bon pour les changements non fonctionnels de s'assurer qu'il n'y a pas de régression visuelle.

Environnement de mise en scène

• URL : https://service-manual.apps.y.cld.gov.au/
• Branche : develop
• statut :

Environnements de test (provisionnement automatique)

• Les succursales déployées avec le suffixe «-stage» seront déployées dans un nouvel environnement.
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• Exemple test-staging https://service-manual-test-staging.apps.y.cld.gov.au/

Développement

Toutes les demandes de traction doivent être comparées à develop . Pour garder les choses simples, optez pour l'option Docker mais le bricolage est également fourni. Découvrez d'abord le référentiel:

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

Option 1: Docker

Construisez l'image Docker:

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

Exécutez l'image:

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

Maintenant, pointez votre navigateur vers votre hôte docker avec quelque chose comme http://localhost/

Option 2: DIY

Il est recommandé d'installer nvm pour gérer votre version de nœud locale.

Modifier la version du nœud

nvm use

Installer des dépendances

npm install

Construisez les actifs statiques

npm run build

Démarrer le serveur de développement

npm run watch

Contenu

Tout le contenu du manuel de service est dans le dossier /content . Nous utilisons CuttleBelle comme générateur de sites statique que pour séparer proprement le contenu de la mise en page.

Les images pour les pages de contenu peuvent être stockées dans le dossier /content/assets .

Métadonnées

Les métadonnées peuvent être stockées sur des pages dans le fichier index.yml . Tous les champs à l'exception de pagetitle sont facultatifs.

Champs

• pagetitle (string required)
  • Le titre de la page
• description (string optional)
  • la méta description
• keywords (string, comma delimited list, optional)
  • pour le moteur de recherche
• created_by (string optional)
  • est affiché sur des pages en utilisant intro_with_nav
• published_date (ISO date yyyy-mm-dd optional)
  • est affiché sur des pages en utilisant intro_with_nav
  • Assurez-vous de former comme une chaîne, par exemple "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • est affiché sur des pages en utilisant intro_with_nav
  • Assurez-vous de former comme une chaîne, par exemple "2018-05-12"
• boost (integer optional)
  • influence les résultats du moteur de recherche
• hidden (boolean optional)
  • cache la page si elle est définie sur true
• weight (integer optional)
  • influence la commande des éléments de menu

Moteur de recherche

La recherche est fournie par le moteur de recherche JavaScript LUNR.

Le poids à la recherche est dans l'ordre descendant suivant:

1. keywords (boost = 30)
2. title (boost = 10)
3. description (boost = 5)
4. body (pas de boost)

Le contenu est indexé au moment de la création et peut être influencé par les keywords en option des Metadata Fields et boost .

Booster

Utilisez de petites valeurs, comme 0,5 à 1 jusqu'à ce que le résultat de recherche souhaité soit atteint.

Mots clés

Des mots clés peuvent être ajoutés dans une liste délimitée par virgule.

Pages fédérées

Les pages externes peuvent être fédérées en ajoutant des données aux scripts/federate.js

Combos spéciaux

Des combinaisons de mots spéciales à deux mots peuvent être ajoutées pour améliorer les résultats pour des requêtes spécifiques. Un exemple est le rôle «responsable de la livraison».

Comment ajouter un combo spécial:

1. Ajoutez la combinaison à la function specialCombos(query) dans 06-search-results.js .
2. Ajoutez le terme à deux mots dans les mots clés de la page

Rechercher les données de données statiques

Les données de recherche et les index sont stockées dans les fichiers statiques suivants, qui sont déployés avec le site:

1. Documents.json (les données du document du site)
2. pathmap.json (table de recherche pour le serp)
3. search_index.json (index sérialisé de Lunr)

Reconstruire l'index de recherche dans le développement

Lors de l'expérimentation du réglage de la recherche en développement, il est nécessaire de reconstruire l'index de recherche après avoir modifié le contenu ou les métadonnées. Cela peut être fait chaud dans une autre fenêtre de terminal avec CuttleBelle en cours d'exécution.

 npm run build:search