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
• 状態：

テスト環境（自動プロビジョニング）

• 「-staging」サフィックスで展開されたブランチは、新しい環境に展開されます。
• 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/ようなものでブラウザをDockerホストに向けます

オプション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にデータを追加することでフェデレーションすることができます

特別なコンボ

特定のクエリの結果を改善するために、2つの単語の特別な単語の組み合わせを追加できます。例は、「配信マネージャー」の役割です。

特別なコンボを追加する方法：

1. 06-search-results.jsでfunction specialCombos(query)に組み合わせを追加します。
2. ページのキーワードに2つの単語用語を追加します

データの静的ファイルを検索します

検索データとインデックスは、サイトに展開されている次の静的ファイルに保存されます。

1. documents.json（サイトドキュメントデータ）
2. pathmap.json（SERPのルックアップテーブル）
3. search_index.json（lunrのシリアル化されたインデックス）

開発の検索インデックスの再構築

開発中の検索チューニングを実験するときは、コンテンツまたはメタデータを変更した後、検索インデックスを再構築する必要があります。これは、Cuttlebelleが実行されている別のターミナルウィンドウで熱くすることができます。

 npm run build:search