Este repositório contém:
A casa oficial deste repositório é https://github.com/acl-org/acl-anthology.
Consulte o ReadMe separado para o pacote Python para obter informações detalhadas.
Essas são instruções básicas sobre a geração do site da ACL Anthology, como visto em https://aclantology.org/.
Para construir o site de antologia, você precisará:
bin/requirements.txt
; Para instalar, execute pip -r bin/requirements.txt
libyaml-dev
e Cython
antes de executar, make
a primeira vez, a biblioteca da Líbia C será usada em vez de uma implementação do Python, acelerando a compilação.Há uma ação de ações do GitHub executando a implantação diretamente do GitHub. Para usar isso, você precisa definir essa variável em suas configurações de repositório (interface da Web: Configurações -> Segredos):
PUBLISH_SSH_KEY
: a chave secreta no formato PEM padrão para autenticação (sem senha) O GitHub criará e implantará automaticamente o mestre atual sempre que a ramificação mestre mudar. Isso é feito através do destino upload
no Makefile.
Clone o repositório de antologia para sua máquina local:
$ git clone https://github.com/acl-org/acl-anthology
Desde que você tenha instalado corretamente todos os requisitos, a criação do site deve ser uma make
simples de execução do diretório para o qual você clonou o repositório.
O site totalmente gerado estará em build/anthology
depois. Se ocorrer algum erro durante esta etapa, você poderá consultar o ReadMe detalhado para obter mais informações sobre as etapas individuais executadas para criar o site. Você pode ver o site resultante lançando um servidor da web local com make serve
, que o servirá em http: // localhost: 8000.
Observe que a construção do site é um processo bastante intensivo de recursos; Particularmente a última etapa, invocando Hugo, usa cerca de 18 ~ GB de memória do sistema. Construir a antologia leva cerca de 10 minutos em um laptop com um SSD.
( Nota: isso não significa que você precisa dessa quantidade de RAM em seu sistema; de fato, o site se baseia bem em um laptop com 8 GB de RAM. O sistema pode diminuir temporariamente a desaceleração devido à troca, no entanto. A figura de aprox. 18 GB é o uso máximo de RAM relatado ao executar hugo --minify --stepAnalysis
.)
A antologia pode ser vista localmente executando o hugo server
no hugo/
Diretório. Observe que ele reconstrói o site e, portanto, leva cerca de um minuto para começar.
Primeiro, a criação de um espelho é lenta e enfatiza a infraestrutura de antologia da ACL, porque na configuração inicial você deve baixar todos os arquivos da antologia do servidor oficial da web. Isso pode levar até 8 horas, não importa a rapidez com que sua conexão seja. Então, por favor, não brinque com isso apenas por diversão.
Se você deseja hospedar um espelho, precisará definir duas variáveis de ambiente:
ANTHOLOGY_PREFIX
O prefixo http Seu espelho será acessível sob por exemplo, https://example.com/my-awesome-mirror ou http://aclantology.lst.uni-saarland.de (observe que não há redução no final!)ANTHOLOGYFILES
o diretório sob o qual documentos, anexos etc. residirão no seu servidor da web. Este diretório precisa ser legível pelo seu servidor da web (obviamente), mas não deve ser um subdiretório do diretório espelhado da antologia. Com essas variáveis definidas, você é make
para criar as páginas e make mirror
para refletir todos os arquivos adicionais no diretório Build/Anthology-Files. Se você já criou um espelho antes, ele apenas baixará os arquivos ausentes.
Se você deseja espelhar os papéis, mas não todos os acessórios, poderá executar make mirror-no-attachments
.
Em seguida, você é o diretório build/website/
para o seu servidor da web ou, se você servir o espelho em um subdiretório FOO
, você espelho build/website/FOO
. O diretório build/anthology-files
precisa ser rsync-ed no diretório ANTHOLOGYFILES
do seu servidor da web.
Como você provavelmente deseja manter o espelho atualizado, você pode modificar o shell script bin/acl-mirror-cronjob.sh
para suas necessidades.
Você precisará deste software no servidor
Se você deseja que o processo de construção seja rápido, instale cython3
e libyaml-dev
(veja acima).
Observe que a geração da antologia exige um pouco de RAM, portanto, verifique se está disponível em sua máquina.
Se você quiser contribuir para a antologia da ACL, dê uma olhada em:
Este repo foi originalmente Wing-NUS/ACL e foi transferido para o ACL-ORG a partir de 5 de junho de 2017.
O código para a construção da antologia da ACL é distribuído sob a licença Apache, v2.0.