service manual

디지털 가이드

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

우리는 팀에게 영감을주고 훌륭한 디지털 서비스를 설계하고 제공하는 방법을 지원하는 명확하고 일관되고 설득력있는 지침을 제공하는 것을 목표로합니다.

부분 (레이아웃) 문서

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

CUMTERBELL AUTO-DOC는 gh-pages 지점에 배치됩니다.

부분을 ​​변경하거나 부분적으로 추가 한 후 문서를 업데이트하려면 gh-pages BRING으로 변경하고 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/ 와 같은 것을 사용하여 브라우저를 Docker 호스트에 가리 킵니다.

옵션 2 : DIY

로컬 노드 버전을 관리하기 위해 nvm 설치하는 것이 좋습니다.

노드 버전을 변경하십시오

nvm use

종속성을 설치하십시오

npm install

정적 자산을 구축하십시오

npm run build

개발 서버를 시작하십시오

npm run watch

콘텐츠

서비스 매뉴얼의 모든 컨텐츠는 /content 폴더에 있습니다. 우리는 Cultlebelle을 정적 사이트 생성기로 사용하여 컨텐츠를 레이아웃과 깨끗하게 분리합니다.

컨텐츠 페이지의 이미지는 /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 (부스트 없음)

컨텐츠는 빌드 타임에 색인화되며 옵션 메타 데이터 필드 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의 직렬화 된 색인)

개발 중 검색 인덱스 재건

개발 중 검색 튜닝을 실험 할 때는 컨텐츠 또는 메타 데이터를 변경 한 후 검색 인덱스를 재건해야합니다. CUMTERBELL이 실행되는 다른 터미널 창에서는 뜨거운 작업을 수행 할 수 있습니다.

 npm run build:search