I just tried to start my local antora Fedora docs build environment and it failed:
$ ./build.sh && ./preview.sh
This build script is using Docker container runtime to run the build in an isolated environment.
Unable to find image 'antora/antora:latest' locally
latest: Pulling from antora/antora 97518928ae5f: Pull complete 16a1a5057866: Pull complete ad8b526cbb1f: Pull complete 0328e268dee9: Pull complete 189b546b5e76: Pull complete 9cb3f4115fdb: Pull complete f4dabaa8a81b: Pull complete Digest: sha256:caf0d59c92c292858d6569dc8a9f4b104f85743db2eaf55f34ef0a2c97a3ef90 Status: Downloaded newer image for antora/antora:latest [07:32:52.861] FATAL (antora): configuration param 'runtime.pull' not declared in the schema for /antora/site.yml (cwd: /antora, playbook: site.yml)
Any idea what went wrong and how to fix it?
Hi, Try with antora:2.3.4 instead of latest. Antora v3 is out and is quite different from v2.
in build.sh: image="docker.io/antora/antora:2.3.4"
On 2021-12-29 08:49, Peter Boy wrote:
I just tried to start my local antora Fedora docs build environment and it failed:
$ ./build.sh && ./preview.sh
This build script is using Docker container runtime to run the build in an isolated environment.
Unable to find image 'antora/antora:latest' locally
latest: Pulling from antora/antora 97518928ae5f: Pull complete 16a1a5057866: Pull complete ad8b526cbb1f: Pull complete 0328e268dee9: Pull complete 189b546b5e76: Pull complete 9cb3f4115fdb: Pull complete f4dabaa8a81b: Pull complete Digest: sha256:caf0d59c92c292858d6569dc8a9f4b104f85743db2eaf55f34ef0a2c97a3ef90 Status: Downloaded newer image for antora/antora:latest [07:32:52.861] FATAL (antora): configuration param 'runtime.pull' not declared in the schema for /antora/site.yml (cwd: /antora, playbook: site.yml)
Any idea what went wrong and how to fix it? _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
Hi,
Should we go around all repos and update the build scripts to use that image for now? From https://docs.antora.org/antora/latest/project/release-schedule/, Antora 2.3.4 will be EOL in February this year which is a really fast EOL. Should we try to move all Fedora docs to v3 ASAP? I'm not familiar with the changes required.
Thanks!
Moved to https://discussion.fedoraproject.org/t/antora-v3-release-and-impact-on-fedor... as per latest thread here.
Sorry for my late response here. Somehow I received the all the replies not by email and - after spending a lot of time adding articles to our server documentation - I wondered about not to receive a response and checked the web page. And hurray, there are answers.
I tried: (1) in site.yml changed beyond runtime the name "pull" by "fetch" and used the latest antora as before when I got the error message. The docs compiled but with several error messages:
-----<
pb@Peters-iMac Fedora-server % ./build.sh && ./preview.sh
This build script is using Docker container runtime to run the build in an isolated environment.
[17:45:20.080] WARN (@antora/content-classifier): Start page specified for master@fedora-server not found: ROOT:index [17:45:20.087] WARN (@antora/content-classifier): Start page specified for master@server-working-group not found: ROOT:index [17:45:20.088] WARN (@antora/content-classifier): Start page specified for site not found: fedora-server::index [17:45:21.165] WARN (asciidoctor): skipping reference to missing attribute: author_3 file: /antora/docs/modules/ROOT/pages/sysadmin-postgresql-install.adoc source: /antora (refname: stg <worktree>, start path: docs) [17:45:21.758] WARN (asciidoctor): skipping reference to missing attribute: author_3 file: /antora/docs/modules/ROOT/pages/sysadmin-postgresql-install.adoc source: /antora (refname: stg <worktree>, start path: docs) [17:45:22.074] ERROR (asciidoctor): target of xref not found: sysadmon-postinstall.adoc file: /antora/docs/modules/ROOT/pages/virtualization-vm-install-fedoraserver-cockpit.adoc source: /antora (refname: stg <worktree>, start path: docs) [17:45:22.095] ERROR (asciidoctor): target of xref not found: sysadmin-postinstall/.adoc#_4_increase_security_of_cockpit_access file: /antora/docs/modules/ROOT/pages/virtualization-vm-install-fedoraserver-cockpit.adoc source: /antora (refname: stg <worktree>, start path: docs) [17:45:22.141] ERROR (asciidoctor): target of xref not found: container-nspawn.adoc file: /antora/docs/modules/ROOT/nav.adoc source: /antora (refname: stg <worktree>, start path: docs) Site generation complete! Open file:///antora/public in a browser to view your site.
The preview is available at http://localhost:8080
Spaces: * User Documentation .. http://localhost:8080/fedora-server/ #(default) * Working Group pages.. http://localhost:8080/server-working-group/
The preview will be available at http://localhost:8080/ /docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration /docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/ /docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh 10-listen-on-ipv6-by-default.sh: info: can not modify /etc/nginx/conf.d/default.conf (read-only file system?) /docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh /docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh /docker-entrypoint.sh: Configuration complete; ready for start up 2022/01/09 17:45:23 [notice] 1#1: using the "epoll" event method 2022/01/09 17:45:23 [notice] 1#1: nginx/1.21.5 2022/01/09 17:45:23 [notice] 1#1: built by gcc 10.2.1 20210110 (Debian 10.2.1-6) 2022/01/09 17:45:23 [notice] 1#1: OS: Linux 5.10.76-linuxkit 2022/01/09 17:45:23 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576 2022/01/09 17:45:23 [notice] 1#1: start worker processes 2022/01/09 17:45:23 [notice] 1#1: start worker process 25 2022/01/09 17:45:23 [notice] 1#1: start worker process 26 2022/01/09 17:45:32 [error] 25#25: *1 directory index of "/antora/public/" is forbidden, client: 172.17.0.1, server: localhost, request: "GET / HTTP/1.1", host: "localhost:8080" 172.17.0.1 - - [09/Jan/2022:17:45:32 +0000] "GET / HTTP/1.1" 403 153 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:95.0) Gecko/20100101 Firefox/95.0" "-" 2022/01/09 17:45:32 [error] 25#25: *1 open() "/antora/public/favicon.ico" failed (2: No such file or directory), client: 172.17.0.1, server: localhost, request: "GET /favicon.ico HTTP/1.1", host: "localhost:8080", referrer: "http://localhost:8080/" 172.17.0.1 - - [09/Jan/2022:17:45:32 +0000] "GET /favicon.ico HTTP/1.1" 404 153 "http://localhost:8080/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:95.0) Gecko/20100101 Firefox/95.0" "-" 2022/01/09 17:45:55 [notice] 1#1: signal 28 (SIGWINCH) received 2022/01/09 17:45:55 [notice] 1#1: signal 28 (SIGWINCH) received 2022/01/09 17:45:55 [notice] 1#1: signal 28 (SIGWINCH) received
---<
And localhost:8080 came up with 403 forbidden.
(2) I switched site.yml back to the "pull" as before and modified build.sh into: image="docker.io/antora/antora:2.3.4"
I got
----<
pb@Peters-iMac Fedora-server % ./build.sh && ./preview.sh
This build script is using Docker container runtime to run the build in an isolated environment.
Unable to find image 'antora/antora:2.3.4' locally 2.3.4: Pulling from antora/antora ddad3d7c1e96: Pull complete de915e575d22: Pull complete 7150aa69525b: Pull complete d7aa47be044e: Pull complete b574a12936b8: Pull complete e3f89e967f67: Pull complete 3d5d72ba839e: Pull complete Digest: sha256:61952efd4c53c854e7ecd445ae29ad4bf5a0dc37c2389b7aba9906da3faccc4f Status: Downloaded newer image for antora/antora:2.3.4 asciidoctor: WARNING: skipping reference to missing attribute: author_3 asciidoctor: WARNING: skipping reference to missing attribute: author_3
The preview is available at http://localhost:8080
Spaces: * User Documentation .. http://localhost:8080/fedora-server/ #(default) * Working Group pages.. http://localhost:8080/server-working-group/
The preview will be available at http://localhost:8080/ /docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration /docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/ /docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh 10-listen-on-ipv6-by-default.sh: info: can not modify /etc/nginx/conf.d/default.conf (read-only file system?) /docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh /docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh /docker-entrypoint.sh: Configuration complete; ready for start up 2022/01/09 17:50:15 [notice] 1#1: using the "epoll" event method 2022/01/09 17:50:15 [notice] 1#1: nginx/1.21.5 2022/01/09 17:50:15 [notice] 1#1: built by gcc 10.2.1 20210110 (Debian 10.2.1-6) 2022/01/09 17:50:15 [notice] 1#1: OS: Linux 5.10.76-linuxkit 2022/01/09 17:50:15 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576 2022/01/09 17:50:15 [notice] 1#1: start worker processes 2022/01/09 17:50:15 [notice] 1#1: start worker process 25 2022/01/09 17:50:15 [notice] 1#1: start worker process 26
---<
and everything worked fine as before.
Thus Antora 3.0 seems to require further adjustments (besides the errors in my docs that version 2.3.4 skips or ignores but 3.0 reports).
Thanks for the info.
Peter
Additionally to the runtime.fetch setting, you need to double check that any xrefs have the adoc extension specified.
In antora 2, this extension was automatically added if missing. That is no longer the case in 3.0 [1]. For example, in your site.yml, site.start_page should be fedora-server::index.adoc Same for <module>/antora.yml, start_page will became ROOT:index.adoc
[1]: https://docs.antora.org/antora/latest/install/upgrade-antora/#checklist
Thanks for the information and especially the copy to my PM.
I fixed the antora.yml file as well and everything works fine now.
Having a look at the upgrade checklist I fear some surprises, e.g. with the changes in linking to attached documents. But maybe I didn't understand it correctly on the first quick glance - I almost hope so.
Thanks Peter
docs@lists.stg.fedoraproject.org