service manual

Panduan Digital

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

Kami bertujuan untuk memberikan panduan yang jelas, konsisten, dan menarik yang akan menginspirasi tim dan membantu mendukung mereka dengan cara merancang dan memberikan layanan digital yang hebat.

Dokumentasi parsial (tata letak)

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

DoCs Auto Cuttlebelle dikerahkan ke Cabang gh-pages .

Untuk memperbarui dokumentasi setelah mengubah atau menambahkan sebagian, ubah ke cabang gh-pages dan jalankan npm run docs . Dorong untuk digunakan.

Tes regresi visual

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

Ini dapat dijalankan secara opsional sebelum penyebaran produksi untuk secara visual melihat perbedaannya.

Ini baik untuk perubahan non-fungsional untuk memastikan tidak ada regresi visual.

Lingkungan pementasan

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

Lingkungan Uji (penyediaan otomatis)

• Cabang-cabang yang dikerahkan dengan akhiran '-taging' akan digunakan ke lingkungan baru.
• https://service-manual-[branchname-staging].apps.y.cld.gov.au/
• Contoh test-staging Cabang https://service-manual-test-taging.apps.y.cld.gov.au/

Perkembangan

Semua permintaan tarik harus dibandingkan dengan develop . Untuk menjaga hal -hal sederhana, pilih opsi Docker tetapi DIY juga disediakan. Pertama -tama periksa repositori:

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

Opsi 1: Docker

Bangun gambar Docker:

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

Jalankan gambar:

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

Sekarang arahkan browser Anda ke host Docker Anda dengan sesuatu seperti http://localhost/

Opsi 2: DIY

Disarankan Anda menginstal nvm untuk mengelola versi node lokal Anda.

Ubah Versi Node

nvm use

Instal dependensi

npm install

Bangun aset statis

npm run build

Mulai server pengembangan

npm run watch

Isi

Semua konten untuk manual layanan ada di folder /content . Kami menggunakan Cuttlebelle sebagai generator situs statis untuk memisahkan konten yang bersih dari tata letak.

Gambar untuk halaman konten dapat disimpan di folder /content/assets .

Metadata

Metadata dapat disimpan di halaman dalam file index.yml . Semua bidang kecuali untuk pagetitle adalah opsional.

Bidang

• pagetitle (string required)
  • judul halaman
• description (string optional)
  • deskripsi meta
• keywords (string, comma delimited list, optional)
  • untuk mesin pencari
• created_by (string optional)
  • ditampilkan di halaman menggunakan intro_with_nav
• published_date (ISO date yyyy-mm-dd optional)
  • ditampilkan di halaman menggunakan intro_with_nav
  • Pastikan untuk membentuk sebagai string misalnya "2018-05-12"
• reviewed_date (ISO date yyyy-mm-dd optional)
  • ditampilkan di halaman menggunakan intro_with_nav
  • Pastikan untuk membentuk sebagai string misalnya "2018-05-12"
• boost (integer optional)
  • memengaruhi hasil mesin pencari
• hidden (boolean optional)
  • menyembunyikan halaman jika diatur ke true
• weight (integer optional)
  • memengaruhi pemesanan item menu

Mesin pencari

Pencarian disediakan oleh mesin pencari Lunr JavaScript.

Berat badan untuk mencari skor dalam urutan menurun berikut:

1. keywords (Boost = 30)
2. title (Boost = 10)
3. description (boost = 5)
4. body (tidak ada dorongan)

Konten diindeks pada waktu build, dan dapat dipengaruhi dengan keywords dan boost bidang metadata opsional.

Mendorong

Gunakan nilai -nilai kecil, seperti 0,5 - 1 sampai hasil pencarian yang Anda inginkan tercapai.

Kata kunci

Kata kunci dapat ditambahkan dalam daftar koma yang dibatasi.

Halaman federasi

Halaman Eksternal dapat diabaikan dengan menambahkan data ke scripts/federate.js

Kombo khusus

Dua kombinasi kata khusus kata dapat ditambahkan untuk meningkatkan hasil untuk kueri tertentu. Contohnya adalah peran 'Manajer Pengiriman'.

Cara menambahkan kombo khusus:

1. Tambahkan kombinasi ke function specialCombos(query) di 06-search-results.js .
2. Tambahkan dua istilah kata ke dalam kata kunci halaman

Cari Data File Statis

Data pencarian dan indeks disimpan dalam file statis berikut, yang digunakan dengan situs:

1. Documents.json (Data Dokumen Situs)
2. Pathmap.json (Tabel pencarian untuk SERP)
3. search_index.json (indeks serial Lunr)

Membangun kembali indeks pencarian dalam pengembangan

Saat bereksperimen dengan pencarian tuning dalam pengembangan, perlu untuk membangun kembali indeks pencarian setelah mengubah konten atau metadata. Ini bisa dilakukan panas di jendela terminal lain dengan Cuttlebelle berjalan.

 npm run build:search