docs

Author: xeniape

rust/operator-binary/src/discovery.rs

@@ -62,7 +62,7 @@ pub enum Error {
     },
 }
 
-/// Builds discovery [`ConfigMap`]s for connecting to a [`crate::crd::v1alpha1::ZookeeperCluster`] for all expected scenarios
+/// Builds discovery [`ConfigMap`]s for connecting to a [`v1alpha1::ZookeeperCluster`] for all expected scenarios
 #[allow(clippy::too_many_arguments)]
 pub async fn build_discovery_configmaps(
     zk: &v1alpha1::ZookeeperCluster,
@@ -107,7 +107,7 @@ pub async fn build_discovery_configmaps(
     Ok(discovery_configmaps)
 }
 
-/// Build a discovery [`ConfigMap`] containing information about how to connect to a certain [`crate::crd::v1alpha1::ZookeeperCluster`]
+/// Build a discovery [`ConfigMap`] containing information about how to connect to a certain [`v1alpha1::ZookeeperCluster`]
 ///
 /// `hosts` will usually come from either [`pod_hosts`] or [`nodeport_hosts`].
 #[allow(clippy::too_many_arguments)]
@@ -168,7 +168,7 @@ fn build_discovery_configmap(
         .context(BuildConfigMapSnafu)
 }
 
-/// Lists all Pods FQDNs expected to host the [`crate::crd::v1alpha1::ZookeeperCluster`]
+/// Lists all Pods FQDNs expected to host the [`v1alpha1::ZookeeperCluster`]
 fn pod_hosts<'a>(
     zk: &'a v1alpha1::ZookeeperCluster,
     zookeeper_security: &'a ZookeeperSecurity,

rust/operator-binary/src/zk_controller.rs

@@ -1,4 +1,4 @@
-//! Ensures that `Pod`s are configured and running for each [`ZookeeperCluster`]
+//! Ensures that `Pod`s are configured and running for each [`v1alpha1::ZookeeperCluster`]
 use std::{
     borrow::Cow,
     collections::{BTreeMap, HashMap},
@@ -523,7 +523,7 @@ pub async fn reconcile_zk(
 /// The server-role service is the primary endpoint that should be used by clients that do not perform internal load balancing,
 /// including targets outside of the cluster.
 ///
-/// Note that you should generally *not* hard-code clients to use these services; instead, create a [`v1alpha1::ZookeeperZnode`](`crate::crd::v1alpha1::ZookeeperZnode`)
+/// Note that you should generally *not* hard-code clients to use these services; instead, create a [`v1alpha1::ZookeeperZnode`](`v1alpha1::ZookeeperZnode`)
 /// and use the connection string that it gives you.
 pub fn build_server_role_service(
     zk: &v1alpha1::ZookeeperCluster,

rust/operator-binary/src/znode_controller.rs

@@ -1,6 +1,6 @@
-//! Reconciles state for ZooKeeper znodes between Kubernetes [`ZookeeperZnode`] objects and the ZooKeeper cluster
+//! Reconciles state for ZooKeeper znodes between Kubernetes [`v1alpha1::ZookeeperZnode`] objects and the ZooKeeper cluster
 //!
-//! See [`ZookeeperZnode`] for more details.
+//! See [`v1alpha1::ZookeeperZnode`] for more details.
 use std::{borrow::Cow, convert::Infallible, sync::Arc};
 
 use const_format::concatcp;