service manual

數字指南

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

我們旨在提供清晰，一致和引人注目的指導，這將激發團隊並幫助他們支持如何設計和提供出色的數字服務。

部分（佈局）文檔

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

Cuttlebelle Auto-Docs被部署到gh-pages分支。

要在更改或添加部分後更新文檔，請更改為gh-pages分支並運行npm run docs 。將其推到部署。

視覺回歸測試

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

這些可以在生產部署之前選擇運行，以視覺上查看差異。

這對於非功能性更改是有益的，可以確保沒有視覺回歸。

分期環境

• URL ：https：//service-manual.apps.y.cld.gov.au/
• 分支： develop
• 地位：

測試環境（自動供應）

• 部署的帶有“階段”後綴的分支將部署到新的環境中。
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• 示例分支test-staging https://service-manual-test-staging.apps.y.cld.gov.au/

發展

應將所有拉的請求與develop進行比較。為了保持簡單，請選擇Docker選項，但還提供了DIY。首先查看存儲庫：

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

選項1：Docker

構建Docker圖像：

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

運行圖像：

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

現在，用http://localhost/

選項2：DIY

建議您安裝nvm來管理本地節點版本。

更改節點版本

nvm use

安裝依賴項

npm install

建立靜態資產

npm run build

啟動開發服務器

npm run watch

內容

服務手冊的所有內容都在/content文件夾中。我們使用Cuttlebelle作為靜態站點生成器，以便將內容與佈局清晰分開。

內容頁面的圖像可以存儲在/content/assets文件夾中。

元數據

元數據可以存儲在index.yml文件中的頁面上。除pagetitle以外的所有字段都是可選的。

字段

• pagetitle (string required)
  • 頁面標題
• description (string optional)
  • 元描述
• keywords (string, comma delimited list, optional)
  • 用於搜索引擎
• created_by (string optional)
  • 使用Intro_with_nav在頁面上顯示
• published_date (ISO date yyyy-mm-dd optional)
  • 使用Intro_with_nav在頁面上顯示
  • 確保形成為字符串，例如“ 2018-05-12”
• reviewed_date (ISO date yyyy-mm-dd optional)
  • 使用Intro_with_nav在頁面上顯示
  • 確保形成為字符串，例如“ 2018-05-12”
• boost (integer optional)
  • 影響搜索引擎結果
• hidden (boolean optional)
  • 隱藏頁面如果設置為true
• weight (integer optional)
  • 影響菜單項的排序

搜尋引擎

搜索由Lunr JavaScript搜索引擎提供。

搜索評分的重量按以下降序順序：

1. keywords （Boost = 30）
2. title （Boost = 10）
3. description （Boost = 5）
4. body （沒有提升）

內容在構建時間索引，並且可能會受到可選的元數據字段keywords和boost影響。

促進

使用小值，例如0.5-1，直到達到所需的搜索結果為止。

關鍵字

可以在逗號分隔列表中添加關鍵字。

聯合頁面

可以通過將數據添加到scripts/federate.js來使外部頁面聯合起來。

特殊組合

可以添加兩個單詞的特殊單詞組合以改善特定查詢的結果。一個示例是角色“交貨經理”。

如何添加特殊組合：

1. 將組合附加到06-search-results.js中的function specialCombos(query) 。
2. 將兩個單詞術語添加到頁面的關鍵字中

搜索數據靜態文件

搜索數據和索引存儲在以下靜態文件中，該文件與網站一起部署：

1. Documents.json（網站文檔數據）
2. pathmap.json（SERP的查找表）
3. search_index.json（lunr的序列化索引）

重建開發中的搜索指數

在開發中進行搜索調整時，有必要在更改內容或元數據後重建搜索指數。可以在另一個終端窗口中使用Cuttlebelle運行，這可以很熱。

 npm run build:search