Skip to content

Commit 1c34d98

Browse files
committed
docs: update references to include the version
1 parent fd2f4d0 commit 1c34d98

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

rust/operator-binary/src/crd/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ pub mod versioned {
308308
pub conditions: Vec<ClusterCondition>,
309309
}
310310

311-
/// Reference to a single `Pod` that is a component of a [`ZookeeperCluster`]
311+
/// Reference to a single `Pod` that is a component of a [`v1alpha1::ZookeeperCluster`]
312312
///
313313
/// Used for service discovery.
314314
pub struct ZookeeperPodRef {

rust/operator-binary/src/discovery.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pub enum Error {
6565
},
6666
}
6767

68-
/// Builds discovery [`ConfigMap`]s for connecting to a [`ZookeeperCluster`] for all expected scenarios
68+
/// Builds discovery [`ConfigMap`]s for connecting to a [`v1alpha1::ZookeeperCluster`] for all expected scenarios
6969
#[allow(clippy::too_many_arguments)]
7070
pub async fn build_discovery_configmaps(
7171
zk: &ZookeeperCluster,
@@ -110,7 +110,7 @@ pub async fn build_discovery_configmaps(
110110
Ok(discovery_configmaps)
111111
}
112112

113-
/// Build a discovery [`ConfigMap`] containing information about how to connect to a certain [`ZookeeperCluster`]
113+
/// Build a discovery [`ConfigMap`] containing information about how to connect to a certain [`v1alpha1::ZookeeperCluster`]
114114
///
115115
/// `hosts` will usually come from either [`pod_hosts`] or [`nodeport_hosts`].
116116
#[allow(clippy::too_many_arguments)]
@@ -171,7 +171,7 @@ fn build_discovery_configmap(
171171
.context(BuildConfigMapSnafu)
172172
}
173173

174-
/// Lists all Pods FQDNs expected to host the [`ZookeeperCluster`]
174+
/// Lists all Pods FQDNs expected to host the [`v1alpha1::ZookeeperCluster`]
175175
fn pod_hosts<'a>(
176176
zk: &'a ZookeeperCluster,
177177
zookeeper_security: &'a ZookeeperSecurity,

rust/operator-binary/src/zk_controller.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ pub async fn reconcile_zk(
525525
/// The server-role service is the primary endpoint that should be used by clients that do not perform internal load balancing,
526526
/// including targets outside of the cluster.
527527
///
528-
/// Note that you should generally *not* hard-code clients to use these services; instead, create a [`ZookeeperZnode`](`stackable_zookeeper_crd::ZookeeperZnode`)
528+
/// Note that you should generally *not* hard-code clients to use these services; instead, create a [`v1alpha1::ZookeeperZnode`](`crate::crd::v1alpha1::ZookeeperZnode`)
529529
/// and use the connection string that it gives you.
530530
pub fn build_server_role_service(
531531
zk: &ZookeeperCluster,

0 commit comments

Comments
 (0)