이 저장소에는 다음이 포함됩니다.
이 저장소의 공식 홈은 https://github.com/acl-org/acl-anthology입니다.
자세한 정보는 Python 패키지의 별도 ReadMe를 참조하십시오.
https://aclanthology.org/에 표시된대로 ACL Anthology 웹 사이트 생성에 대한 기본 지침입니다.
선집 웹 사이트를 구축하려면 다음이 필요합니다.
bin/requirements.txt
에 나열된 Python 패키지 .txt; 설치하려면 pip -r bin/requirements.txt
실행하십시오libyaml-dev
및 Cython
설치하는 경우 처음 make
Libyaml C 라이브러리를 Python 구현 대신에 사용하여 빌드 속도를 높입니다.GitHub에서 직접 배포를 수행하는 GitHub Action Action Action이 있습니다. 이를 사용하려면 저장소 설정 에서이 변수를 정의해야합니다 (웹 인터페이스 : 설정 -> 비밀) :
PUBLISH_SSH_KEY
: 인증을위한 표준 PEM 형식의 비밀 키 (암호 제외) 그런 다음 Github는 마스터 브랜치가 변경 될 때마다 현재 마스터를 자동으로 빌드하고 배포합니다. 이것은 makefile의 upload
대상을 통해 수행됩니다.
선집 repo를 현지 기계로 복제하십시오.
$ git clone https://github.com/acl-org/acl-anthology
모든 요구 사항을 올바르게 설치 한 경우 웹 사이트를 구축하는 것은 Repo를 복제 한 디렉토리에서 간단하게 make
됩니다.
완전히 생성 된 웹 사이트는 나중에 build/anthology
에 있습니다. 이 단계에서 오류가 발생하면 사이트를 구축하기 위해 수행 된 개별 단계에 대한 자세한 내용은 자세한 readme에 문의하십시오. make serve
와 함께 로컬 웹 서버를 시작하여 결과 웹 사이트를 볼 수 있습니다.
웹 사이트를 구축하는 것은 상당히 자원 집약적 인 프로세스입니다. 특히 휴고를 호출하는 마지막 단계는 약 18 ~ GB의 시스템 메모리를 사용합니다. 선집을 구축하는 데는 SSD가있는 노트북에서 약 10 분이 걸립니다.
( 참고 : 이것은 시스템 에이 양의 RAM이 필요하다는 의미는 아닙니다 . 실제로 웹 사이트는 8GB의 RAM이있는 노트북에서 잘 구축됩니다. 그러나 스왑으로 인해 시스템이 일시적으로 속도가 느려질 수 있습니다. 18GB는 hugo --minify --stepAnalysis
실행할 때보고 된 최대 RAM 사용입니다.)
선집은 hugo/
Directory에서 hugo server
실행하여 로컬로 볼 수 있습니다. 사이트를 재구성하므로 시작하는 데 약 1 분이 걸립니다.
첫째, 미러 생성은 느리고 ACL 선집 인프라에 강조됩니다. 초기 설정에서는 공식 웹 서버에서 선집의 모든 단일 파일을 다운로드해야하기 때문입니다. 연결 이 얼마나 빨리 있든 최대 8 시간이 걸릴 수 있습니다. 그러니 재미를 위해 이것으로 놀지 마십시오.
거울을 호스팅하려면 두 가지 환경 변수를 설정해야합니다.
ANTHOLOGY_PREFIX
http 접두사 당신의 거울은 https://example.com/my-awesome-mirror 또는 http://aclanthology.lst.uni-saarland.de (끝에 슬래시가 없다는 통지!)에서 도달 할 수 있습니다.ANTHOLOGYFILES
종이, 첨부 파일 등이 웹 서버에 상주하는 디렉토리. 이 디렉토리는 웹 서버가 읽을 수 있어야하지만 (분명히) 선집 미러 디렉토리의 하위 디렉토리가되어서는 안됩니다. 이러한 변수가 설정되면 make
실행하여 페이지를 만들고 모든 추가 파일을 빌드/선집 파일 디렉토리에 미러링하기 위해 make mirror
. 이미 거울을 만든 경우 누락 된 파일 만 다운로드합니다.
종이를 반영하지만 모든 첨부 파일이 아니라면 대신 make mirror-no-attachments
실행할 수 있습니다.
그런 다음 build/website/
디렉토리를 웹 서버에 동기화하거나 하위 디렉토리 FOO
에서 거울을 제공하는 경우 거울 build/website/FOO
. build/anthology-files
디렉토리는 웹 서버의 ANTHOLOGYFILES
디렉토리에 rsync-ed해야합니다.
거울을 최신 상태로 유지하려면 쉘 스크립트 bin/acl-mirror-cronjob.sh
귀하의 요구에 맞게 수정할 수 있습니다.
서버 에서이 소프트웨어가 필요합니다
빌드 프로세스가 빠르려면 cython3
및 libyaml-dev
설치하십시오 (위 참조).
선집을 생성하려면 약간의 RAM이 필요하므로 컴퓨터에서 사용할 수 있는지 확인하십시오.
ACL 선집에 기여하고 싶다면 다음을 살펴보십시오.
이 저장소는 원래 Wing-Nus/ACL이었으며 2017 년 6 월 5 일 현재 ACL-ORG로 전송되었습니다.
ACL 선집 구축 코드는 Apache 라이센스 v2.0에 따라 배포됩니다.