docs: Remove outdated and long winded doc comments

Author: Techassi

crates/stackable-operator/src/cli/mod.rs

@@ -1,111 +1,6 @@
-//! This module provides helper methods to deal with common CLI options using the `clap` crate.
-//!
-//! In particular it currently supports handling two kinds of options:
-//! * CRD printing
-//! * Product config location
-//!
-//! # Example
-//!
-//! This example show the usage of the CRD functionality.
-//!
-//! ```no_run
-//! // Handle CLI arguments
-//! use clap::{crate_version, Parser};
-//! use kube::CustomResource;
-//! use schemars::JsonSchema;
-//! use serde::{Deserialize, Serialize};
-//! use stackable_operator::{CustomResourceExt, cli, shared::crd};
-//!
-//! const OPERATOR_VERSION: &str = "23.1.1";
-//!
-//! #[derive(Clone, CustomResource, Debug, JsonSchema, Serialize, Deserialize)]
-//! #[kube(
-//!     group = "foo.stackable.tech",
-//!     version = "v1",
-//!     kind = "FooCluster",
-//!     namespaced
-//! )]
-//! pub struct FooClusterSpec {
-//!     pub name: String,
-//! }
-//!
-//! #[derive(Clone, CustomResource, Debug, JsonSchema, Serialize, Deserialize)]
-//! #[kube(
-//!     group = "bar.stackable.tech",
-//!     version = "v1",
-//!     kind = "BarCluster",
-//!     namespaced
-//! )]
-//! pub struct BarClusterSpec {
-//!     pub name: String,
-//! }
-//!
-//! #[derive(clap::Parser)]
-//! #[command(
-//!     name = "Foobar Operator",
-//!     author,
-//!     version,
-//!     about = "Stackable Operator for Foobar"
-//! )]
-//! struct Opts {
-//!     #[clap(subcommand)]
-//!     command: cli::Command,
-//! }
-//!
-//! # fn main() -> Result<(), crd::Error> {
-//! let opts = Opts::parse();
-//!
-//! match opts.command {
-//!     cli::Command::Crd => {
-//!         FooCluster::print_yaml_schema(OPERATOR_VERSION)?;
-//!         BarCluster::print_yaml_schema(OPERATOR_VERSION)?;
-//!     },
-//!     cli::Command::Run { .. } => {
-//!         // Run the operator
-//!     }
-//! }
-//! # Ok(())
-//! # }
-//! ```
-//!
-//! Product config handling works similarly:
-//!
-//! ```no_run
-//! use clap::{crate_version, Parser};
-//! use stackable_operator::cli;
-//!
-//! #[derive(clap::Parser)]
-//! #[command(
-//!     name = "Foobar Operator",
-//!     author,
-//!     version,
-//!     about = "Stackable Operator for Foobar"
-//! )]
-//! struct Opts {
-//!     #[clap(subcommand)]
-//!     command: cli::Command,
-//! }
-//!
-//! # fn main() -> Result<(), cli::Error> {
-//! let opts = Opts::parse();
-//!
-//! match opts.command {
-//!     cli::Command::Crd => {
-//!         // Print CRD objects
-//!     }
-//!     cli::Command::Run(cli::ProductOperatorRun { product_config, watch_namespace, .. }) => {
-//!         let product_config = product_config.load(&[
-//!             "deploy/config-spec/properties.yaml",
-//!             "/etc/stackable/spark-operator/config-spec/properties.yaml",
-//!         ])?;
-//!     }
-//! }
-//! # Ok(())
-//! # }
-//!
-//! ```
-//!
-//!
+//! Contains various types for composing the CLI interface for operators and other applications
+//! running in a Kubernetes cluster.
+
 use clap::{Args, Parser};
 use stackable_telemetry::tracing::TelemetryOptions;