service manual

Цифровые гиды

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

Мы стремимся предоставить четкое, последовательное и убедительное руководство, которое вдохновляет команды и поможет поддержать их в том, как проектировать и предоставлять отличные цифровые услуги.

Частичная (макет) документация

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

Автофьюсоды Cuttlebelle развернуты в филиале 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

Теперь укажите свой браузер на свой хост 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)
  • скрывает страницу, если установлен на истину
• 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. Добавьте комбинацию к function specialCombos(query) в 06-search-results.js .
2. Добавьте два слова в ключевые слова страницы

Поиск данных статические файлы

Данные поиска и индексы хранятся в следующих статических файлах, которые развернуты с сайтом:

1. documents.json (данные документа сайта)
2. pathmap.json (таблица поиска для SERP)
3. search_index.json (сериализованный индекс LUNR)

Восстановление индекса поиска в разработке

При экспериментировании с настройкой поиска в разработке необходимо восстановить индекс поиска после изменения контента или метаданных. Это может быть сделано горячим в другом окне терминала с бегом каттлбелле.

 npm run build:search