stackabletech / documentation

Stackable's central documentation repository built on Antora
https://docs.stackable.tech
Apache License 2.0
11 stars 11 forks source link

fix: invalid reference #636

Closed NickLarsenNZ closed 4 months ago

NickLarsenNZ commented 4 months ago

Part of https://github.com/stackabletech/documentation/pull/635

[!CAUTION] This might be a hack, and maybe the correct way is to use :page-aliases: ..., but even then since it is broken within each release that would also require PRs for each release.

01387e5958cfb2711efe2900b536aaf3bc48e649 fixes:

[16:23:57.555] ERROR (asciidoctor): target of xref not found: home::kubernetes.adoc
    file: modules/concepts/pages/overview.adoc
    source: /home/nick/dev/github.com/stackabletech/documentation/.git (branch: release/24.3)

Remaining errors to fix in this PR:

[16:23:58.557] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/airflow/pages/usage-guide/storage-resources.adoc
    source: https://github.com/stackabletech/airflow-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.557] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/airflow/pages/usage-guide/storage-resources.adoc
    source: https://github.com/stackabletech/airflow-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.642] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/druid/pages/usage-guide/resources-and-storage.adoc
    source: https://github.com/stackabletech/druid-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.643] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/druid/pages/usage-guide/resources-and-storage.adoc
    source: https://github.com/stackabletech/druid-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.731] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/hbase/pages/usage-guide/resource-requests.adoc
    source: https://github.com/stackabletech/hbase-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.732] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/hbase/pages/usage-guide/resource-requests.adoc
    source: https://github.com/stackabletech/hbase-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.818] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/hdfs/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/hdfs-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.818] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/hdfs/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/hdfs-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.907] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/hive/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/hive-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.907] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/hive/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/hive-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.983] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/kafka/pages/usage-guide/storage-resources.adoc
    source: https://github.com/stackabletech/kafka-operator.git (branch: release-24.3 | start path: docs)
[16:23:58.983] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/kafka/pages/usage-guide/storage-resources.adoc
    source: https://github.com/stackabletech/kafka-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.063] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/nifi/pages/usage_guide/resource-configuration.adoc
    source: https://github.com/stackabletech/nifi-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.063] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/nifi/pages/usage_guide/resource-configuration.adoc
    source: https://github.com/stackabletech/nifi-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.286] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/spark-k8s/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/spark-k8s-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.287] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/spark-k8s/pages/usage-guide/resources.adoc
    source: https://github.com/stackabletech/spark-k8s-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.404] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/trino/pages/usage-guide/configuration.adoc
    source: https://github.com/stackabletech/trino-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.405] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/trino/pages/usage-guide/configuration.adoc
    source: https://github.com/stackabletech/trino-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.540] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#roles
    file: docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc
    source: https://github.com/stackabletech/zookeeper-operator.git (branch: release-24.3 | start path: docs)
[16:23:59.540] ERROR (asciidoctor): target of xref not found: concepts:stacklet.adoc#role-groups
    file: docs/modules/zookeeper/pages/usage_guide/resource_configuration.adoc
    source: https://github.com/stackabletech/zookeeper-operator.git (branch: release-24.3 | start path: docs)

There will be similar changes needed for other branches.

NickLarsenNZ commented 4 months ago

Here was my diff btw, just to speed things up and see less errors:

diff --cc local-antora-playbook.yml
index 51050bde,4d2577be..00000000
--- a/local-antora-playbook.yml
+++ b/local-antora-playbook.yml
@@@ -17,10 -15,12 +17,26 @@@ content
      - url: ./
        branches:
          - HEAD
++<<<<<<< Updated upstream
 +        - release/23.11
 +        - release/23.7
 +        - release/23.4
 +        - release/23.1
++||||||| Stash base
++        - release/24.7
++        - release/24.3
++        - release/23.11
++        - release/23.7
++        - release/23.4
++        - release/23.1
++=======
+         - release/24.7
+         - release/24.3
+         # - release/23.11
+         # - release/23.7
+         # - release/23.4
+         # - release/23.1
++>>>>>>> Stashed changes
      # management tools
      - url: https://github.com/stackabletech/stackable-cockpit.git
        start_path: docs
@@@ -30,133 -30,164 +46,389 @@@
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      # internal operators
      - url: https://github.com/stackabletech/commons-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/secret-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/listener-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      # product operators
      - url: https://github.com/stackabletech/airflow-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/druid-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/hbase-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/hdfs-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/hive-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/kafka-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/nifi-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/opa-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/spark-k8s-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/superset-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/trino-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
      - url: https://github.com/stackabletech/zookeeper-operator.git
        start_path: docs
        branches:
          - main
++<<<<<<< Updated upstream
 +        - release-23.11
 +        - release-23.7
 +        - release-23.4
 +        - release-23.1
 +
++||||||| Stash base
++        - release-24.7
++        - release-24.3
++        - release-23.11
++        - release-23.7
++        - release-23.4
++        - release-23.1
++=======
+         - release-24.7
+         - release-24.3
+         # - release-23.11
+         # - release-23.7
+         # - release-23.4
+         # - release-23.1
++>>>>>>> Stashed changes
  ui:
    bundle:
      url: ./ui/build/ui-bundle.zip