docs.rs updates

- documenting features, linking to kube.rs/features
- adding an informer alias so that people that search for informer land on watcher
- add a logo to the lhs of the docs.rs/kube page

Signed-off-by: clux <[email protected]>

Author: clux

kube-runtime/src/watcher.rs

@@ -719,6 +719,7 @@ where
 /// that we have seen on the stream. If this is successful then the stream is simply resumed from where it left off.
 /// If this fails because the resource version is no longer valid then we start over with a new stream, starting with
 /// an [`Event::Init`]. The internals mechanics of recovery should be considered an implementation detail.
+#[doc(alias = "informer")]
 pub fn watcher<K: Resource + Clone + DeserializeOwned + Debug + Send + 'static>(
     api: Api<K>,
     watcher_config: Config,

kube/Cargo.toml

@@ -13,32 +13,50 @@ categories = ["network-programming", "caching", "api-bindings", "encoding"]
 
 [features]
 default = ["client", "rustls-tls", "ring"]
+#! See [kube.rs/features](https://kube.rs/features/) for more details
 
-# default features
+## default client
 client = ["kube-client/client", "config"]
+## default config
 config = ["kube-client/config"]
+## default tls stack
 rustls-tls = ["kube-client/rustls-tls", "client"]
 
-# alternative features
+## legacy tls stack (must disable rustls-tls to use)
 openssl-tls = ["kube-client/openssl-tls", "client"]
+## aws rustls provider
 aws-lc-rs = ["kube-client?/aws-lc-rs"]
+## ring rustls provider
 ring = ["kube-client?/ring"]
+## enable webpki roots in rustls
+webpki-roots = ["kube-client/webpki-roots", "client"]
 
-# auxiliary features
+## enable kube-derive and proc macros
+derive = ["kube-derive", "kube-core/schema"]
+## enable runtime for controllers/watchers/reflectors
+runtime = ["kube-runtime"]
+## enable websocket client support for portforward/exec/attach
 ws = ["kube-client/ws", "kube-core/ws"]
-kubelet-debug = ["kube-client/kubelet-debug", "kube-core/kubelet-debug"]
+## enable client oauth support
 oauth = ["kube-client/oauth", "client"]
+## enable client oidc support
 oidc = ["kube-client/oidc", "client"]
+## enable client socks5 support
+socks5 = ["kube-client/socks5", "client"]
+## enable client http proxy support
+http-proxy = ["kube-client/http-proxy", "client"]
+## enable client gzip usage
 gzip = ["kube-client/gzip", "client"]
+## enable support for jsonpatch style patch parameters
 jsonpatch = ["kube-core/jsonpatch"]
+## enable the admission module
 admission = ["kube-core/admission"]
-derive = ["kube-derive", "kube-core/schema"]
-runtime = ["kube-runtime"]
+## enable unstable runtime features
 unstable-runtime = ["kube-runtime/unstable-runtime", "runtime"]
+## enable unstable client features
 unstable-client = ["kube-client/unstable-client", "client"]
-socks5 = ["kube-client/socks5", "client"]
-http-proxy = ["kube-client/http-proxy", "client"]
-webpki-roots = ["kube-client/webpki-roots", "client"]
+## enable the kubelet debug interface
+kubelet-debug = ["kube-client/kubelet-debug", "kube-core/kubelet-debug"]
 
 [package.metadata.docs.rs]
 features = ["client", "rustls-tls", "openssl-tls", "derive", "ws", "oauth", "jsonpatch", "admission", "runtime", "k8s-openapi/latest", "unstable-runtime", "socks5", "http-proxy"]

kube/src/lib.rs

@@ -1,3 +1,6 @@
+#![doc(
+    html_logo_url = "https://user-images.githubusercontent.com/639336/155115130-758a8ba9-e209-42de-bf6d-cde7be3ed86f.svg#only-light"
+)]
 //! Kube is an umbrella-crate for interacting with [Kubernetes](http://kubernetes.io) in Rust.
 //!
 //! # Overview
@@ -103,6 +106,9 @@
 //!
 //! # Examples
 //! A large list of complete, runnable examples with explainations are available in the [examples folder](https://github.com/kube-rs/kube/tree/main/examples).
+//!
+//! # Features
+//! Documented at [kube.rs/features](https://kube.rs/features/).
 #![cfg_attr(docsrs, feature(doc_cfg))]
 
 macro_rules! cfg_client {