หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

gov.uk เอกสารทางเทคนิคการเข้าสู่ระบบหนึ่งครั้ง

repo นี้มีเอกสารประกอบเพื่อช่วยเหลือนักเทคโนโลยีในหน่วยงานรัฐบาลในการเข้าสู่ระบบ gov.uk หนึ่งครั้ง มันเผยแพร่โดยใช้เทมเพลตเอกสารทางเทคนิค

การเปลี่ยนแปลงเนื้อหา

ทีมงานเขียนทางเทคนิคการเข้าสู่ระบบของ Gov.uk เป็นเจ้าของเอกสารนี้และมีหน้าที่รับผิดชอบในการอนุมัติการเปลี่ยนแปลงเนื้อหา มีการเขียนว่าเป็นศูนย์กลางของผู้ใช้และเป็นไปตามมาตรฐานเนื้อหา GDS ซึ่งหมายถึงการติดตาม:

  • คำแนะนำ gov.uk เกี่ยวกับการวางแผนการเขียนและการจัดการเนื้อหา
  • คู่มือสไตล์ gov.uk
  • คู่มือสไตล์เทคนิค gov.uk
  • หลักการเขียนที่ชัดเจนอื่น ๆ

หากคุณทำงานกับ gov.uk หนึ่งการเข้าสู่ระบบคุณควรติดต่อทีมงานเขียนเทคโนโลยีเพื่อขอความช่วยเหลือเกี่ยวกับการเปลี่ยนแปลงเนื้อหาเว้นแต่ว่าจะมีขนาดเล็กและไม่ส่งผลกระทบต่อพฤติกรรมของผู้ใช้

การเปลี่ยนแปลงเนื้อหาเล็ก ๆ รวมถึง:

  • การเพิ่มคำอธิบายเพื่อปรับปรุงความเข้าใจ
  • การแก้ไขตัวอย่างรหัส
  • การแก้ไขลิงก์ที่เสียหรือพิมพ์ผิด

คุณสามารถทำการเปลี่ยนแปลงเหล่านี้ด้วยตนเองแล้วขอรีวิวนักเขียนด้านเทคโนโลยีเกี่ยวกับคำขอดึง หากคุณไม่แน่ใจว่าการเปลี่ยนแปลงมีขนาดเล็กหรือไม่โปรดติดต่อเราในช่อง Slack #Di-Technical-Writing ของเรา

ทำการเปลี่ยนแปลงทางเทคนิค

ทีม orchestration รับผิดชอบการบำรุงรักษาและสุขภาพการปฏิบัติงานของแพลตฟอร์มเอกสารเทคโนโลยี คุณควรปรึกษาพวกเขาเพื่อขออนุมัติการเปลี่ยนแปลงใด ๆ ในพื้นที่นั้น

ตัวอย่าง ได้แก่ :

  • การเปลี่ยนแปลงเวิร์กโฟลว์การกระทำของ GitHub
  • การเปลี่ยนแปลงการปรับใช้ AWS หรือสร้างโครงสร้างพื้นฐาน
  • อัปเดตการพึ่งพา
  • การอัปเดตทับทิมที่ไม่เปลี่ยนเนื้อหา

ดูตัวอย่างการเปลี่ยนแปลงเอกสารของคุณ

ในการดูตัวอย่างการเปลี่ยนแปลงและการเพิ่มเติมใด ๆ ที่คุณทำกับเอกสารในเบราว์เซอร์ให้โคลน repo นี้และใช้ dockerfile ใน repo นี้เพื่อเรียกใช้เซิร์ฟเวอร์ middleman บนเครื่องของคุณโดยไม่ต้องตั้งค่าทับทิมในเครื่อง

การตั้งค่านี้เปิดใช้งานการโหลดซ้ำสดซึ่งหมายความว่าการเปลี่ยนแปลงของคุณจะถูกนำไปใช้เมื่อคุณแก้ไขไฟล์ในไดเรกทอรีต้นฉบับ ข้อยกเว้นเพียงอย่างเดียวคือถ้าคุณทำการเปลี่ยนแปลง config/tech-docs.yml คุณต้องหยุดและรีสตาร์ทเซิร์ฟเวอร์เพื่อดูการเปลี่ยนแปลงของคุณในตัวอย่าง คุณสามารถหยุดเซิร์ฟเวอร์ด้วย Ctrl-C

เรียกใช้สคริปต์ผู้ช่วย: 

./preview-with-docker.sh

อาจใช้เวลาไม่กี่นาทีในการสร้างคอนเทนเนอร์ Docker โดยเฉพาะอย่างยิ่งถ้าเป็นครั้งแรกที่คุณใช้งานสคริปต์ เมื่อเซิร์ฟเวอร์โหลดเสร็จแล้วคุณควรเห็นเอาต์พุตต่อไปนี้ในเทอร์มินัล: 

== View your site at " http://localhost:4567 " , " http://127.0.0.1:4567 "
== Inspect your site configuration at " http://localhost:4567/__middleman " , " http://127.0.0.1:4567/__middleman " /usr/local/bundle/gems/tilt-2.0.11/lib/tilt/redcarpet.

ทำการเปลี่ยนแปลงแผนภาพ

ไดอะแกรมเป็นเนื้อหาดังนั้นเมื่อคุณทำการเปลี่ยนแปลงคุณควรขอรีวิวจากทีมงานเขียนด้านเทคนิค

คุณสามารถแก้ไขไฟล์ draw.io ในโฟลเดอร์ source/images/originals ได้โดยการติดตั้งและใช้แอพ Draw.io Desktop

ใช้ไฟล์ draw.io หนึ่งไฟล์ต่อไดอะแกรม

การติดตั้งแอพ Draw.io Desktop

เรียกใช้คำสั่งต่อไปนี้เพื่อใช้แอพ Draw.io Desktop จากบรรทัดคำสั่ง 

 brew install --cask drawio
alias draw.io='/Applications/draw.io.app/Contents/MacOS/draw.io'

การแก้ไขและเผยแพร่ไดอะแกรม

ทำตามขั้นตอนเหล่านี้:

  1. สร้างและแก้ไขไดอะแกรมโดยใช้ draw.io
  2. บันทึกไฟล์ draw.io ไปยังโฟลเดอร์ source/images/originals
  3. เผยแพร่ไดอะแกรมเป็นกราฟิกเวกเตอร์ที่ปรับขนาดได้ (SVG)
  4. บันทึกไฟล์ SVG ไปยังโฟลเดอร์ source/images

คำสั่งที่มีประโยชน์

อัปเดตไดอะแกรม: 

 draw.io source/images/originals/top-level-technical-diagram.drawio

สร้างไดอะแกรมเวอร์ชัน SVG และบันทึกลงในโฟลเดอร์ source/images/originals : 

 draw.io -x -o source/images/top-level-technical-diagram.svg source/images/originals/top-level-technical-diagram.drawio

draw.io -x -o source/images/technical-flow-diagram.svg source/images/originals/technical-flow-diagram.drawio

ผ้าสำลี Gov.uk One Login Technical Documentation

ที่เก็บนี้ใช้ Vale และ GDS Tech Docs Rulleset Linter Ruleset

การติดตั้ง linter บนเครื่องในพื้นที่ของคุณ

คุณต้องทำ:

  • ติดตั้ง homebrew
  • ติดตั้ง Vale

ผ้าสำลีกับตัวแก้ไขรหัสของคุณ

ตัวแก้ไขรหัสจำนวนมากให้ส่วนขยายหรือปลั๊กอินสำหรับ Vale ซึ่งสามารถเพิ่มข้อผิดพลาดในขณะที่คุณอัปเดตเอกสารประกอบ คุณจะต้องติดตั้ง Vale บนเครื่องในเครื่องของคุณ

ผ้าสำลีด้วยอินเทอร์เฟซบรรทัดคำสั่ง vale (CLI)

โดยค่าเริ่มต้น VALE จะต้องเรียกใช้จากไดเรกทอรีเดียวกับไฟล์กำหนดค่านี้เว้นแต่ว่า -การตั้งค่าสถานะ --config จะมีพา ธ เพื่อเรียกใช้ linter โดยใช้ Vale CLI:

  1. ในหน้าต่างเทอร์มินัลนำทางไปยัง repo ของคุณ
  2. เรียกใช้ vale sync เพื่อดาวน์โหลดแพ็คเกจ Tech-Docs-Linter ล่าสุดและคลายซิปลงใน StylesPath ของคุณในไฟล์กำหนดค่าของคุณ
  3. เรียกใช้คำสั่ง vale . เพื่อผ้าสำลี repo ทั้งหมดหรือจัดเตรียมเส้นทางไปยังไดเรกทอรีไปที่ผ้าสำลีเท่านั้นเช่นไดเรกทอรีนั้นตัวอย่างเช่น vale ./source/go-live

การอัปเดตไปยัง Docs Tech Docs Linter Ruleset

หากมีการเพิ่มกฎใหม่ลงใน Docs Tech Docs Ruleset ชุดคุณสามารถ upversion แพ็คเกจที่ใช้โดย repo นี้เมื่อคุณพร้อม สามารถทดสอบและเพิ่มชุดกฎในภายหลังได้โดย:

  1. สร้างสาขา
  2. อัปเดตหมายเลขเวอร์ชันแพ็คเกจในไฟล์กำหนดค่า VALE
  3. เรียกใช้ vale sync เพื่อดาวน์โหลดและคลายซิปแพ็คเกจล่าสุด
  4. Run vale ./source เพื่อทดสอบ linter
  5. แก้ไขการเปลี่ยนแปลงใด ๆ ที่กฎใหม่เกิดขึ้น
  6. เพิ่ม PR ด้วยหมายเลขเวอร์ชันล่าสุดในไฟล์ Config Vale

จรรยาบรรณ

โปรดดูจรรยาบรรณของ alphagov

ใบอนุญาต

เว้นแต่จะระบุไว้เป็นอย่างอื่น Codebase จะถูกปล่อยภายใต้ใบอนุญาต MIT สิ่งนี้ครอบคลุมทั้ง codebase และรหัสตัวอย่างใด ๆ ในเอกสาร

เอกสารนี้คือ© Crown Copyright และมีอยู่ภายใต้เงื่อนไขของใบอนุญาตเปิดรัฐบาล 3.0

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด