service manual

Digitale Führer

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

Wir wollen klare, konsistente und überzeugende Anleitungen geben, die Teams inspirieren und ihnen helfen, wie man großartige digitale Dienste entwirft und anbietet.

Teilweise (Layout-) Dokumentation

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

Die Cuttlebelle-Auto-Docs werden in der gh-pages -Filiale eingesetzt.

Um die Dokumentation nach dem Ändern oder Hinzufügen eines Teils zu aktualisieren, wechseln Sie den gh-pages -Zweig und führen Sie npm run docs aus. Drücken Sie es zur Bereitstellung.

Visuelle Regressionstests

https://github.com/govau/backstop-guidestests

Diese können optional vor einem Produktionsbereitstellung ausgeführt werden, um den Unterschied visuell zu erkennen.

Es ist gut für nicht funktionierende Änderungen, um sicherzustellen, dass keine visuelle Regression vorliegt.

Staging -Umgebung

• URL : https://service-manual.apps.y.cld.gov.au/
• Zweig : develop
• Status :

Testumgebungen (automatische Bereitstellung)

• Zweige, die mit dem Suffix "-Staging" eingesetzt werden, werden in einer neuen Umgebung eingesetzt.
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• Beispiel Branch test-staging

Entwicklung

Alle Pull -Anfragen sollten mit develop verglichen werden. Um die Dinge einfach zu halten, entscheiden Sie sich für die Option Docker, aber auch die DIY wird bereitgestellt. Schauen Sie sich zunächst das Repository an:

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

Option 1: Docker

Erstellen Sie das Docker -Bild:

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

Führen Sie das Bild aus:

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

Zeigen Sie jetzt Ihren Browser auf Ihren Docker -Host mit so etwas wie http://localhost/

Option 2: DIY

Es wird empfohlen, nvm zu installieren, um Ihre lokale Knotenversion zu verwalten.

Knotenversion ändern

nvm use

Abhängigkeiten installieren

npm install

Bauen Sie die statischen Vermögenswerte auf

npm run build

Starten Sie den Entwicklungsserver

npm run watch

Inhalt

Alle Inhalte für das Servicehandbuch befinden sich im Ordner /content . Wir verwenden Cuttlebelle als statischer Site -Generator, um den Inhalt von Layout sauber zu trennen.

Bilder für Inhaltsseiten können im Ordner /content/assets gespeichert werden.

Metadaten

Metadaten können auf Seiten innerhalb der index.yml -Datei gespeichert werden. Alle Felder mit Ausnahme von pagetitle sind optional.

Felder

• pagetitle (string required)
  • Der Seitentitel
• description (string optional)
  • Die Meta -Beschreibung
• keywords (string, comma delimited list, optional)
  • für Suchmaschinen
• created_by (string optional)
  • wird auf Seiten mit intro_with_nav angezeigt
• published_date (ISO date yyyy-mm-dd optional)
  • wird auf Seiten mit intro_with_nav angezeigt
  • Stellen Sie sicher, dass Sie sich als Zeichenfolge bilden, z. "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • wird auf Seiten mit intro_with_nav angezeigt
  • Stellen Sie sicher, dass Sie sich als Zeichenfolge bilden, z. "2018-05-12"
• boost (integer optional)
  • beeinflusst die Suchmaschinenergebnisse
• hidden (boolean optional)
  • versteckt die Seite, wenn sie auf True gesetzt sind
• weight (integer optional)
  • beeinflusst die Bestellung von Menüpunkten

Suchmaschine

Die Suche wird von der Lunr JavaScript -Suchmaschine bereitgestellt.

Die Suche nach Gewicht zur Suche befindet sich in der folgenden absteigenden Reihenfolge:

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

Der Inhalt wird zum Bauzeit indexiert und kann mit den optionalen keywords und boost optionalen Metadaten beeinflusst werden.

Schub

Verwenden Sie kleine Werte wie 0,5 - 1, bis das gewünschte Suchergebnis erzielt wird.

Schlüsselwörter

Schlüsselwörter können in einer von Comma abgrenzten Liste hinzugefügt werden.

Föderierte Seiten

Externe Seiten können durch Hinzufügen von Daten zu scripts/federate.js föderiert werden

Spezielle Combos

Es können zwei Wörter spezielle Wortkombinationen hinzugefügt werden, um die Ergebnisse für bestimmte Abfragen zu verbessern. Ein Beispiel ist die Rolle "Liefermanager".

So fügen Sie eine spezielle Kombination hinzu:

1. Gehen Sie die Kombination an die function specialCombos(query) in 06-search-results.js .
2. Fügen Sie den Two Word Term in die Schlüsselwörter der Seite hinzu

Suchen Sie Daten statische Dateien

Suchdaten und Indizes werden in den folgenden statischen Dateien gespeichert, die mit der Website bereitgestellt werden:

1. documents.json (die Site -Dokumentdaten)
2. pathmap.json (Suchtabelle für die SERP)
3. Search_index.json (serialisierter Index von Lunr)

Wiederaufbau des Suchindex in der Entwicklung wieder aufbauen

Beim Experimentieren mit Suchabstimmung in der Entwicklung ist es erforderlich, den Suchindex nach Ändern von Inhalten oder Metadaten wieder aufzubauen. Dies kann in einem anderen Terminalfenster heiß gemacht werden, wobei Cuttebelle läuft.

 npm run build:search