Skip to content

fix: remove home: from refs #637

Closed
Closed
@NickLarsenNZ

Description

@NickLarsenNZ

From @fhennig:
The problem is in the include directives in the operators, on the old branches. The docs state:

If the version coordinate isn’t specified, Antora uses the latest version of the target page’s component to complete the resource ID at runtime. This behavior only applies when the target page and current page belong to different docs components.

This means that if a component is specified in an include directive (i.e. "home") but without a version, the latest version is used. We do not want that we want to include from the same version. The fix is to simply remove the component directive. I've made a fix for Airflow 24.3, here is the commit: stackabletech/airflow-operator@669691c

unfortunately this means that you will need to push this fix into all release branches of all operators ... so a lot of PRs

Example fix:

- include::home:concepts:stackable_resource_requests.adoc[]
+ include::concepts:stackable_resource_requests.adoc[]
  1. Checkout the release-xx.xx branch (make sure it is up to date)
  2. Create a new branch off it, fix/release-xx.xx-remove-home-xref
    Sample commit message: docs: remove home module from refs (stackabletech/documentation#637)
  3. Raise a PR back into the release-xx.xx branch

Note

The documentation repo uses the release/xx.xx style.

Update the below tasklists with the subsequent PR

Non-Operators Repos

### Fixes for documentation releases
- [ ] https://github.com/stackabletech/documentation/pull/638
- [ ] https://github.com/stackabletech/documentation/pull/640
- [ ] https://github.com/stackabletech/documentation/pull/641
- [ ] https://github.com/stackabletech/documentation/pull/642
- [ ] https://github.com/stackabletech/documentation/pull/643
- [x] nothing in 24.7
### Fixes for demos releases
- [ ] https://github.com/stackabletech/demos/pull/76
- [ ] https://github.com/stackabletech/demos/pull/77
- [ ] https://github.com/stackabletech/demos/pull/79
- [ ] https://github.com/stackabletech/demos/pull/78
- [ ] https://github.com/stackabletech/demos/pull/80
- [ ] https://github.com/stackabletech/demos/pull/81
- [ ] https://github.com/stackabletech/demos/pull/82
- [ ] https://github.com/stackabletech/demos/pull/83
- [ ] https://github.com/stackabletech/demos/pull/84

Operators

### Fixes for airflow-operator releases
- [ ] https://github.com/stackabletech/airflow-operator/pull/479
- [ ] https://github.com/stackabletech/airflow-operator/pull/480
- [ ] https://github.com/stackabletech/airflow-operator/pull/481
- [ ] https://github.com/stackabletech/airflow-operator/pull/482
- [ ] https://github.com/stackabletech/airflow-operator/pull/483
- [ ] https://github.com/stackabletech/airflow-operator/pull/484
### Fixes for commons-operator releases
- [ ] https://github.com/stackabletech/commons-operator/pull/274
### Fixes for druid-operator releases
- [ ] https://github.com/stackabletech/druid-operator/pull/607
- [ ] https://github.com/stackabletech/druid-operator/pull/608
- [ ] https://github.com/stackabletech/druid-operator/pull/609
- [ ] https://github.com/stackabletech/druid-operator/pull/610
- [ ] https://github.com/stackabletech/druid-operator/pull/611
- [ ] https://github.com/stackabletech/druid-operator/pull/612
### Fixes for hbase-operator releases
- [ ] https://github.com/stackabletech/hbase-operator/pull/540
- [ ] https://github.com/stackabletech/hbase-operator/pull/541
- [ ] https://github.com/stackabletech/hbase-operator/pull/542
- [ ] https://github.com/stackabletech/hbase-operator/pull/543
- [ ] https://github.com/stackabletech/hbase-operator/pull/544
- [ ] https://github.com/stackabletech/hbase-operator/pull/545
### Fixes for hdfs-operator releases
- [ ] https://github.com/stackabletech/hdfs-operator/pull/565
- [ ] https://github.com/stackabletech/hdfs-operator/pull/566
- [ ] https://github.com/stackabletech/hdfs-operator/pull/567
- [ ] https://github.com/stackabletech/hdfs-operator/pull/568
- [ ] https://github.com/stackabletech/hdfs-operator/pull/569
- [ ] https://github.com/stackabletech/hdfs-operator/pull/570
### Fixes for hive-operator releases
- [ ] https://github.com/stackabletech/hive-operator/pull/497
- [ ] https://github.com/stackabletech/hive-operator/pull/498
- [ ] https://github.com/stackabletech/hive-operator/pull/499
- [ ] https://github.com/stackabletech/hive-operator/pull/500
- [ ] https://github.com/stackabletech/hive-operator/pull/501
- [ ] https://github.com/stackabletech/hive-operator/pull/502
### Fixes for kafka-operator releases
- [ ] https://github.com/stackabletech/kafka-operator/pull/742
- [ ] https://github.com/stackabletech/kafka-operator/pull/743
- [ ] https://github.com/stackabletech/kafka-operator/pull/744
- [ ] https://github.com/stackabletech/kafka-operator/pull/745
- [ ] https://github.com/stackabletech/kafka-operator/pull/746
- [ ] https://github.com/stackabletech/kafka-operator/pull/747
### Fixes for listener-operator releases
- [x] Nothing to fix
### Fixes for nifi-operator releases
- [ ] https://github.com/stackabletech/nifi-operator/pull/653
- [ ] https://github.com/stackabletech/nifi-operator/pull/654
- [ ] https://github.com/stackabletech/nifi-operator/pull/655
- [ ] https://github.com/stackabletech/nifi-operator/pull/656
- [ ] https://github.com/stackabletech/nifi-operator/pull/657
- [ ] https://github.com/stackabletech/nifi-operator/pull/658
- [ ] https://github.com/stackabletech/nifi-operator/pull/659
### Fixes for opa-operator releases
- [ ] https://github.com/stackabletech/opa-operator/pull/610
- [ ] https://github.com/stackabletech/opa-operator/pull/611
- [ ] https://github.com/stackabletech/opa-operator/pull/612
- [ ] https://github.com/stackabletech/opa-operator/pull/613
- [ ] https://github.com/stackabletech/opa-operator/pull/614
- [x] Nothing to do for 24.7
### Fixes for secret-operator releases
- [x] Nothing to fix
### Fixes for spark-k8s-operator releases
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/442
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/443
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/444
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/445
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/446
- [ ] https://github.com/stackabletech/spark-k8s-operator/pull/447
### Fixes for superset-operator releases
- [ ] https://github.com/stackabletech/superset-operator/pull/520
- [ ] https://github.com/stackabletech/superset-operator/pull/521
- [ ] https://github.com/stackabletech/superset-operator/pull/522
- [ ] https://github.com/stackabletech/superset-operator/pull/523
- [ ] https://github.com/stackabletech/superset-operator/pull/524
- [x] 24.7 (no refs?)
### Fixes for trino-operator releases
- [ ] https://github.com/stackabletech/trino-operator/pull/624
- [ ] https://github.com/stackabletech/trino-operator/pull/625
- [ ] https://github.com/stackabletech/trino-operator/pull/626
- [ ] https://github.com/stackabletech/trino-operator/pull/629
- [ ] https://github.com/stackabletech/trino-operator/pull/627
- [ ] https://github.com/stackabletech/trino-operator/pull/628
### Fixes for zookeeper-operator releases
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/844
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/845
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/846
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/847
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/848
- [ ] https://github.com/stackabletech/zookeeper-operator/pull/849

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions