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