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-strage.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

الآن قم بإشارة متصفحك إلى مضيف Docker الخاص بك بشيء مثل 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 (التعزيز = 30)
2. title (Boost = 10)
3. description (التعزيز = 5)
4. body (لا دفعة)

يتم فهرسة المحتوى في وقت الإنشاء ، ويمكن أن يتأثر بالكلمات الرئيسية للبيانات الوصفية الاختيارية boost keywords .

يعزز

استخدم القيم الصغيرة ، مثل 0.5 - 1 حتى يتم تحقيق نتيجة البحث المطلوب.

الكلمات الرئيسية

يمكن إضافة الكلمات الرئيسية في قائمة محددة فاصلة.

الصفحات الفيدرالية

يمكن اتباع الصفحات الخارجية عن طريق إضافة بيانات إلى scripts/federate.js

مجموعات خاصة

يمكن إضافة مجموعات كلمات خاصة بكلمة لتحسين النتائج لاستعلامات محددة. مثال على ذلك هو دور "مدير التوصيل".

كيفية إضافة مجموعة خاصة:

1. قم بإلحاق المجموعة function specialCombos(query) في 06-search-results.js .
2. أضف مصطلح كلمتين إلى الكلمات الرئيسية للصفحة

ابحث عن الملفات الثابتة للبيانات

يتم تخزين بيانات البحث وفهارسها في الملفات الثابتة التالية ، والتي يتم نشرها مع الموقع:

1. documents.json (بيانات مستند الموقع)
2. pathmap.json (جدول البحث لـ SERP)
3. Search_index.json (فهرس Lunr المسلسل)

إعادة بناء مؤشر البحث في التطوير

عند تجربة ضبط البحث في التطوير ، من الضروري إعادة بناء فهرس البحث بعد تغيير المحتوى أو البيانات الوصفية. يمكن القيام بذلك ساخنًا في نافذة طرفية أخرى مع تشغيل Cuttlebelle.

 npm run build:search