search

opendevstack / ods-provisioning-app

Provisioning app, which triggers project and component provisions (including Jira / Confluence / BitBucket and OCP resource creation)
Apache License 2.0
15 stars 20 forks source link

docs - antora3 preps - xref errors in 3.x/4.x/master #719

Closed tbugfinder closed 2 years ago

tbugfinder commented 2 years ago

Describe the bug XREF in docs branch 3.x/4.x/master invalid

Warning could be fixed, too - code variables require escape characters in asciidoc.


3.x:
[22:05:14.144] ERROR (asciidoctor): target of xref not found: provisioning-app:configuration.adoc:Authentication Crowd Configuration
    file: docs/modules/provisioning-app/pages/architecture.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 3.x, start path: docs)
[22:05:14.183] WARN (asciidoctor): skipping reference to missing attribute: projectidorkey
    file: docs/modules/provisioning-app/pages/configuration.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 3.x, start path: docs)
[22:05:14.197] ERROR (asciidoctor): target of xref not found: jenkins:slave-base.adoc
    file: docs/modules/provisioning-app/pages/index.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 3.x, start path: docs)

4.x:
[22:05:14.973] ERROR (asciidoctor): target of xref not found: provisioning-app:configuration.adoc:Authentication Crowd Configuration
    file: docs/modules/provisioning-app/pages/architecture.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 4.x, start path: docs)
[22:05:15.044] WARN (asciidoctor): skipping reference to missing attribute: projectidorkey
    file: docs/modules/provisioning-app/pages/configuration.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 4.x, start path: docs)
[22:05:15.077] ERROR (asciidoctor): target of xref not found: jenkins:slave-base.adoc
    file: docs/modules/provisioning-app/pages/index.adoc
    source: https://github.com/opendevstack/ods-provisioning-app.git (refname: 4.x, start path: docs)

master:
[22:05:15.832] WARN (asciidoctor): skipping reference to missing attribute: projectidorkey
    file: /antora/ods-provisioning-app/docs/modules/provisioning-app/pages/configuration.adoc
    source: /antora/ods-provisioning-app (refname: master <worktree>, start path: docs)
[22:05:15.846] ERROR (asciidoctor): target of xref not found: jenkins:slave-base.adoc
    file: /antora/ods-provisioning-app/docs/modules/provisioning-app/pages/index.adoc
    source: /antora/ods-provisioning-app (refname: master <worktree>, start path: docs)

architecture.adoc (xref might not deal with spaces?):

== Consuming REST APIs via curl

Basic Auth authentication is the recommended way to consume REST API. How to enable Basic Auth authentication is explained xref:provisioning-app:configuration.adoc:Authentication Crowd Configuration[here].

https://github.com/opendevstack/ods-documentation/issues/66