vshn / appcat-user-docs

Antora documentation for the APPUiO Cloud AppCat
https://docs.appcat.ch/
0 stars 3 forks source link

Duplicate Section IDs in CRD docs #48

Closed tobru closed 1 year ago

tobru commented 1 year ago

In crds.adoc, which is generated by the generator, some sections do have the same ID, which is wrong and AsciiDoc complains accordingly:

{"level":"warn","time":1679916788312,"name":"asciidoctor","file":{"path":"/preview/antora/docs/modules/ROOT/pages/references/crds.adoc","line":102},"source":{"url":"https://github.com/vshn/appcat-user-docs.git","local":"/preview/antora/.git","worktree":"/preview/antora","refname":"master","reftype":"branch","startPath":"docs"},"msg":"id assigned to section already in use: api-reference"}
{"level":"warn","time":1679916788410,"name":"asciidoctor","file":{"path":"/preview/antora/docs/modules/ROOT/pages/references/crds.adoc","line":615},"source":{"url":"https://github.com/vshn/appcat-user-docs.git","local":"/preview/antora/.git","worktree":"/preview/antora","refname":"master","reftype":"branch","startPath":"docs"},"msg":"id assigned to section already in use: api-reference"}

Possible solution:

The list template might need to be enhanced to have a dynamic section ID.

wejdross commented 1 year ago

https://github.com/vshn/appcat-user-docs/pull/84