Штучное обновление было изначально запланировано и реализовано, но потом было принято решение от него отказаться для избежания конфликтов с пакетным обновлением справок. Тем не менее, описанный ниже процесс можно использовать для накопления штучных изменений с целью последующего переноса этих изменений в общий csv-файл.
Замечание: пачка может состоять из обновления одной справки; обновление пачкой это единственный способ обновить/добавить справки.
Для обновления справок нужно:
Формат файла:
;#кодировка файла: utf-8
Администратор:
если файл предоставлен в кодировки cp1215 его нужно сначала конвертнуть в utf:
iconv -f cp1251 all-cp1251.csv > all.csv
замените файл data/spravki/all.csv на новую версию
проверьте изменения
git diff
сделайте комит
сделайте пул-реквест
после вливания пул-реквеста, гитхаб автоматически обновит сборку
далее следуйте инструкциям по обновлению сайта (в частности, инструкция по обновлению сайта после изменений в папке hugo/ -- см ниже "Памятка Администраторам") и по обновлению индекса (раздел "Elasticsearch")
Текст данного раздела хранится в файле hugo/content/about/index.md. Это копия оригинального сайта. Используется формат html. При редактировании можно использовать формат markdown. Для обновления раздела, пришлите новую версию файла адмниистратору
Clone repo to your machine
git clone --recursive
Install hugo:
cd /tmp wget https://github.com/gohugoio/hugo/releases/download/v0.71.1/hugo_0.71.1_Linux-64bit.deb sudo dpkg -i hugo*.deb
Install python packages
sudo pip3 install oyaml
Get and run Elasticsearch
docker run -d \ --name=elasticsearch \ -p 127.0.0.1:9200:9200 \ -p 127.0.0.1:9300:9300 \ -e "ES_JAVA_OPTS=-Xms1g -Xmx1g" \ -e "discovery.type=single-node" \ -e "http.cors.enabled=true" \ -e "http.cors.allow-origin=*" \ docker.elastic.co/elasticsearch/elasticsearch:7.7.1
Elasticsearch is available from localhost only. You need to configure web server (e.g. Nginx) to pass /persons/_search and /lists/_search search requests to elasticsearch, for example:
upstream upstream_static { server 185.199.109.153; } upstream upstream_elasticsearch { server localhost:9200; } server { listen 80; location ~ /(persons|lists)/_search { proxy_set_header Host $host; proxy_pass http://upstream_elasticsearch;
auth_basic "Administrator’s Area";
auth_basic_user_file /etc/apache2/.htpasswd;
}
location / {
proxy_set_header Host $host;
proxy_pass http://upstream_static;
auth_basic "Administrator’s Area";
auth_basic_user_file /etc/apache2/.htpasswd;
}}
Don't forget to configure robots.txt
To compile website after changes in data, data2hugo folders run the following command:
make hugo
-- it will make updates in hugo folder
To compile website after changes in hugo (including hugo/data/spravki) folder run the following command:
make website
-- it will generate website in hugo/public/ folder.
You may also need to check baseURL setting in hugo/config.toml
It's recommended to automate CI/CD process. Check GIthub Actions scripts for examples.
It's recommended upload static pages first and then update search index.
Лучше всего сначала обновить страницы сайта, а потом поиск, чтобы в течение промежутка вермени между этими обновлениями пользователь не оказался в ситуации, когда он нашел персону в поиске со справкой, перешел на страницу и не нашел полную версию справки.
В качестве css-фреймворка используется bulma
cd hugo
hugo server --templateMetricsTo run hugo on remote server, you may need to add following arguments:
hugo server --templateMetrics --bind="0.0.0.0" --baseURL=your-dev-server.example.com data2hugomake hugo commandhugo/themes/hugo/ foldertwo columns (primzv)
lists with gb spravka near the name
title pages
list spravka
# generate index files
make search
# upload index files to local Elasticsearch
make upload_searchSee hugo/config.toml
В случае обнаружения в архивных документах недостающих списков, информацию нужно будет вносить в следующих файла и папках
Далее следует воспользоваться памяткой Администратора, чтобы проверить результат. Если страницы списка и персонажей созданы удачно, не забудьте обновить страницу с переченем списков.