Bug 56110

Summary: Кривая сборка документации
Product: Sisyphus Reporter: Vladislav Glinkin <glinkinvd>
Component: pve-docsAssignee: kozorizki <kozorizki>
Status: CLOSED FIXED QA Contact: qa-sisyphus
Severity: normal    
Priority: P5 CC: shaba, shrek
Version: unstable   
Hardware: x86_64   
OS: Linux   
Attachments:
Description Flags
JavaScript код с онлайн-документации Proxmox none

Description Vladislav Glinkin 2025-09-23 13:58:10 MSK
Created attachment 19613 [details]
JavaScript код с онлайн-документации Proxmox

Версия пакета: pve-docs-9.0.8-alt1

Документация для 9 мажорной версии криво собирается, о чём свидетельствуют ошибки и предупреждения в логах сборки:
...
[00:00:04] asciidoc: WARNING: pve-network.adoc: line 162: missing section: [sect5]
[00:00:04] asciidoc: WARNING: pve-network.adoc: line 223: missing section: [sect5]
[00:00:05] asciidoc: WARNING: qm.adoc: line 158: missing section: [sect5]
[00:00:05] asciidoc: WARNING: qm.adoc: line 197: missing section: [sect5]
[00:00:05] asciidoc: WARNING: qm.adoc: line 220: missing section: [sect5]
[00:00:06] asciidoc: WARNING: qm.adoc: line 1935: missing section: [sect5]
[00:00:06] asciidoc: WARNING: qm.adoc: line 1941: missing section: [sect5]
[00:00:06] asciidoc: WARNING: qm.adoc: line 1947: missing section: [sect5]
[00:00:06] asciidoc: WARNING: qm.adoc: line 1960: missing section: [sect5]
[00:00:08] asciidoc: WARNING: ha-manager.adoc: line 758: missing section: [sect5]
[00:00:08] asciidoc: WARNING: ha-manager.adoc: line 826: missing section: [sect5]
[00:00:08] asciidoc: WARNING: ha-manager.adoc: line 845: missing section: [sect5]
[00:00:08] asciidoc: WARNING: ha-manager.adoc: line 863: missing section: [sect5]
[00:00:08] asciidoc: WARNING: notifications.adoc: line 224: missing section: [sect5]
[00:00:08] asciidoc: WARNING: notifications.adoc: line 239: missing section: [sect5]
[00:00:08] asciidoc: WARNING: notifications.adoc: line 254: missing section: [sect5]
...
[00:00:21] ./asciidoc-pve compile-chapter -o chapter-ha-manager.html ha-manager.adoc
[00:00:21] asciidoc: WARNING: .asciidoc-pve-tmp1447183_ha-manager.adoc: line 4: include file not found: /etc/asciidoc/stylesheets/asciidoc.css
[00:00:21] asciidoc: WARNING: .asciidoc-pve-tmp1447183_ha-manager.adoc: line 4: include file not found: /etc/asciidoc/stylesheets/toc2.css
[00:00:21] asciidoc: WARNING: .asciidoc-pve-tmp1447183_ha-manager.adoc: line 4: include file not found: /etc/asciidoc/javascripts/asciidoc.js
...

Той же проблеме подвержена 8 мажорная версия. А вот 7 мажорная версии у нас собирается нормально.

Как следствие, на странице https://pve01:8006/pve-docs/pve-admin-guide.html пустой Table of Contents, кривое форматирование глав.
Браузер жалуется на Uncaught ReferenceError: asciidoc is not defined (https://pve01:8006/pve-docs/pve-admin-guide.html:410)

Шаги воспроизведения:
1) Перейти на https://<адрес сервера>:8006/pve-docs/pve-admin-guide.html

Во вложении прикрепляю файл с JS кодом, которого не хватает для корректно отображения документации. Судя по всему, во время сборки он подставляется в /asciidoc/pve-html.conf:
ifdef::linkcss[]
<script type="text/javascript" src="{scriptsdir=.}/asciidoc.js"></script>
<script type="text/javascript" src="{scriptsdir=.}/{theme}.js"></script>
<script type="text/javascript">
#TODO: Escape not necessary in HTML5?
# Escape as CDATA to pass validators.
/*<![CDATA[*/
asciidoc.install({toc,toc2?{toclevels}});
/*]]>*/
</script>
endif::linkcss[]
ifndef::linkcss[]
<script type="text/javascript">
# Escape as CDATA to pass validators.
/*<![CDATA[*/
include1::{scriptsdir=/etc/asciidoc/javascripts}/asciidoc.js[]
include1::{themedir}/{theme}.js[warnings=False]
asciidoc.install({toc,toc2?{toclevels}});
/*]]>*/
</script>
endif::linkcss[]
Comment 1 Vladislav Glinkin 2025-09-24 12:06:57 MSK
Такая проблема вызвана изменениями в asciidoc - https://github.com/asciidoc-py/asciidoc-py/commit/4d61d4bfa3ca00b01b543a13e695ed518b90ca6d

Как вариант решения проблемы, можно либо пропатчить asciidoc/pve-html.conf, либо сделать в спеке теми же командами вот так:
--- a/pve-docs.spec
+++ b/pve-docs.spec
@@ -24,6 +24,8 @@ grep 'proxmox.com' * -rl | while read f; do
        sed -i 's|proxmox.com|basealt.ru|' $f
 done
 sed -i 's|{python}|python3|' asciidoc/*.conf
+sed -i 's!/etc/asciidoc/stylesheets!/usr/lib/python3/site-packages/asciidoc/resources/stylesheets!g' asciidoc/pve-html.conf
+sed -i 's!/etc/asciidoc/javascripts!/usr/lib/python3/site-packages/asciidoc/resources/javascripts!g' asciidoc/pve-html.conf
 rm -f getting-help.adoc howto-improve-pve-docs.adoc pve-package-repos.adoc pve-faq.adoc pve-installation.adoc pve-system-requirements.adoc translation.adoc pve-installation-media.adoc cpu-models.conf.adoc firmware-updates.adoc

 %build

Второй вариант тут - https://packages.altlinux.org/ru/tasks/395692/
Comment 2 Repository Robot 2025-09-29 20:29:17 MSK
pve-docs-9.0.8-alt2 -> sisyphus:

Thu Sep 25 2025 Konstantin Kozoriz <kozorizki@altlinux> 9.0.8-alt2
- fix: correct resource paths, drop obsolete links (ALT #56110)