ที่เก็บนี้มี:
บ้านอย่างเป็นทางการของที่เก็บนี้คือ https://github.com/acl-org/acl-anthology
โปรดดู readme แยกต่างหากสำหรับแพ็คเกจ Python สำหรับข้อมูลโดยละเอียด
นี่คือคำแนะนำพื้นฐานในการสร้างเว็บไซต์ ACL กวีนิพนธ์ดังที่เห็นใน https://aclanthology.org/
ในการสร้างเว็บไซต์กวีนิพนธ์คุณจะต้อง:
bin/requirements.txt
; หากต้องการติดตั้งให้เรียกใช้ pip -r bin/requirements.txt
libyaml-dev
และ Cython
ก่อนที่จะทำงาน make
ครั้งแรกไลบรารี Libyaml C จะถูกใช้แทนการใช้ Python เพื่อเร่งการสร้างมีการกระทำของ GitHub Action ดำเนินการปรับใช้โดยตรงจาก GitHub ในการใช้สิ่งนี้คุณต้องกำหนดตัวแปรนี้ในการตั้งค่าที่เก็บของคุณ (เว็บอินเตอร์เฟส: การตั้งค่า -> ความลับ):
PUBLISH_SSH_KEY
: คีย์ลับในรูปแบบ PEM มาตรฐานสำหรับการตรวจสอบสิทธิ์ (โดยไม่ต้องใช้รหัสผ่าน) GitHub จะสร้างและปรับใช้ต้นแบบปัจจุบันโดยอัตโนมัติเมื่อใดก็ตามที่สาขาหลักเปลี่ยนไป สิ่งนี้ทำได้ผ่านเป้าหมาย upload
ใน MakeFile
โคลน repo กวีนิพนธ์ไปยังเครื่องในท้องถิ่นของคุณ:
$ git clone https://github.com/acl-org/acl-anthology
หากคุณได้ติดตั้งข้อกำหนดทั้งหมดอย่างถูกต้องการสร้างเว็บไซต์ควร make
งานง่าย ๆ จากไดเรกทอรีที่คุณโคลน repo
เว็บไซต์ที่สร้างขึ้นอย่างสมบูรณ์จะอยู่ใน build/anthology
หลังจากนั้น หากข้อผิดพลาดใด ๆ เกิดขึ้นในขั้นตอนนี้คุณสามารถปรึกษา ReadMe โดยละเอียดสำหรับข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนแต่ละขั้นตอนที่ดำเนินการเพื่อสร้างเว็บไซต์ คุณสามารถดูเว็บไซต์ผลลัพธ์ได้โดยการเปิดตัวเว็บเซิร์ฟเวอร์ในท้องถิ่นด้วย make serve
ซึ่งจะให้บริการที่ http: // localhost: 8000
โปรดทราบว่าการสร้างเว็บไซต์เป็นกระบวนการที่ใช้ทรัพยากรมาก โดยเฉพาะอย่างยิ่งขั้นตอนสุดท้ายเรียก Hugo ใช้หน่วยความจำระบบประมาณ 18 ~ GB การสร้างกวีนิพนธ์ใช้เวลาประมาณ 10 นาทีในแล็ปท็อปที่มี SSD
( หมายเหตุ: นี่ ไม่ได้ หมายความว่าคุณต้องการ RAM จำนวนนี้ในระบบของคุณจริง ๆ แล้วเว็บไซต์สร้างได้ดีบนแล็ปท็อปที่มี RAM 8 GB ระบบอาจชะลอตัวลงชั่วคราวเนื่องจากการแลกเปลี่ยนอย่างไรก็ตามตัวเลขประมาณ 18 GB คือการใช้ RAM สูงสุดที่รายงานเมื่อเรียกใช้ hugo --minify --stepAnalysis
)
กวีนิพนธ์สามารถดูได้ในเครื่องโดยใช้ hugo server
ใน hugo/
Directory โปรดทราบว่าจะสร้างเว็บไซต์ใหม่และใช้เวลาประมาณหนึ่งนาทีในการเริ่มต้น
ขั้นแรกการสร้างกระจกจะช้าและเน้นโครงสร้างพื้นฐานของกวีนิพนธ์ ACL เนื่องจากในการตั้งค่าเริ่มต้นคุณต้องดาวน์โหลดทุกไฟล์ของกวีนิพนธ์จากเว็บเซิร์ฟเวอร์อย่างเป็นทางการ อาจใช้เวลาสูงสุด 8 ชั่วโมงไม่ว่าการเชื่อมต่อ ของคุณ จะเร็วแค่ไหน ดังนั้นโปรดอย่าเล่นกับสิ่งนี้เพื่อความสนุกสนาน
หากคุณต้องการโฮสต์กระจกคุณต้องตั้งค่าตัวแปรสภาพแวดล้อมสองตัว:
ANTHOLOGY_PREFIX
คำนำหน้า http กระจกของคุณจะสามารถเข้าถึงได้ภายใต้เช่น https://example.com/my-awesome-mirror หรือ http://aclanthology.lst.uni-saarland.de (สังเกตว่าไม่มีการเฉือนในตอนท้าย!)ANTHOLOGYFILES
ไดเรกทอรีภายใต้เอกสารสิ่งที่แนบมา ฯลฯ จะอยู่บนเว็บเซิร์ฟเวอร์ของคุณ ไดเรกทอรีนี้จะต้องสามารถอ่านได้โดยเว็บเซิร์ฟเวอร์ของคุณ (เห็นได้ชัด) แต่ไม่ควรเป็นไดเรกทอรีย่อยของไดเรกทอรีมิเรอร์กวีนิพนธ์ ด้วยชุดตัวแปรเหล่านี้คุณเรียกใช้ make
เพื่อสร้างหน้าและ make mirror
เพื่อสะท้อนไฟล์เพิ่มเติมทั้งหมดลงในไดเรกทอรี Build/Anthology-Files หากคุณสร้างมิเรอร์มาก่อนแล้วมันจะดาวน์โหลดไฟล์ที่หายไปเท่านั้น
หากคุณต้องการสะท้อนเอกสาร แต่ไม่ใช่สิ่งที่แนบมาทั้งหมดคุณสามารถเรียกใช้ make mirror-no-attachments
แทน
จากนั้นคุณ rsync build/website/
ไดเรกทอรีไปยังเว็บเซิร์ฟเวอร์ของคุณหรือถ้าคุณให้บริการกระจกใน FOO
subdirectory คุณจะสะท้อน build/website/FOO
ไดเรกทอรี build/anthology-files
จะต้องเป็น rsync-ed ไปยังไดเรกทอรี ANTHOLOGYFILES
ของเว็บเซิร์ฟเวอร์ของคุณ
ในขณะที่คุณอาจต้องการให้กระจกทันสมัยอยู่เสมอคุณสามารถปรับเปลี่ยนเชลล์สคริปต์ bin/acl-mirror-cronjob.sh
ตามความต้องการของคุณ
คุณจะต้องใช้ซอฟต์แวร์นี้บนเซิร์ฟเวอร์
หากคุณต้องการให้กระบวนการสร้างรวดเร็วให้ติดตั้ง cython3
และ libyaml-dev
(ดูด้านบน)
โปรดทราบว่าการสร้างกวีนิพนธ์นั้นใช้ RAM ค่อนข้างน้อยดังนั้นตรวจสอบให้แน่ใจว่ามีอยู่ในเครื่องของคุณ
หากคุณต้องการมีส่วนร่วมในกวีนิพนธ์ ACL โปรดดูที่:
repo นี้เดิมคือ wing-nus/ACL และถูกโอนไปยัง ACL-ORG ณ วันที่ 5 มิถุนายน 2017
รหัสสำหรับการสร้างกวีนิพนธ์ ACL มีการแจกจ่ายภายใต้ใบอนุญาต Apache, v2.0