fix docfx (#1656)

* fix: update file references and clean up validation comments in models

* chore: add symlink to CONTRIBUTING.md for easier access

* fix: update documentation to include full type names for WebSocket and Predicate

* fix: include CONTRIBUTING.md in docfx.json build content

doc/CONTRIBUTING.md

@@ -0,0 +1 @@
+../CONTRIBUTING.md

doc/docfx.json

@@ -4,7 +4,7 @@
       "src": [
         {
           "files": [
-            "KubernetesClient/KubernetesClient.csproj"
+            "KubernetesClient/bin/Release/net8.0/KubernetesClient.dll"
           ],
           "src": "../src"
         }
@@ -20,6 +20,7 @@
         "files": [
           "api/**.yml",
           "index.md",
+          "CONTRIBUTING.md",
           "toc.yml"
         ]
       }

src/KubernetesClient/IStreamDemuxer.cs

@@ -3,13 +3,13 @@ namespace k8s
     /// <summary>
     /// <para>
     ///     The <see cref="IStreamDemuxer"/> interface allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command
-    ///     by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
+    ///     by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
-    ///     or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
+    ///     or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
-    ///     will return you a <see cref="WebSocket"/> connection.
+    ///     will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
     /// </para>
     /// <para>
-    ///     Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
+    ///     Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
-    ///     allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
+    ///     allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
     /// </para>
     /// </summary>
     public interface IStreamDemuxer : IDisposable

src/KubernetesClient/Models/KubernetesList.cs

@@ -44,9 +44,6 @@ namespace k8s.Models
         /// <summary>
         /// Validate the object.
         /// </summary>
-        /// <exception cref="ValidationException">
-        /// Thrown if validation fails
-        /// </exception>
         public void Validate()
         {
             if (Items == null)

src/KubernetesClient/Models/ModelExtensions.cs

@@ -208,7 +208,7 @@ namespace k8s.Models
         /// reference could be found.
         /// </summary>
         /// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
-        /// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
+        /// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
         /// <returns>the index of the <see cref="V1OwnerReference"/> that matches the given object, or -1 if no such
         /// reference could be found.</returns>
         public static int FindOwnerReference(this IMetadata<V1ObjectMeta> obj, Predicate<V1OwnerReference> predicate)
@@ -300,7 +300,7 @@ namespace k8s.Models
 
         /// <summary>Gets the <see cref="V1OwnerReference"/> that matches the given predicate, or null if no matching reference exists.</summary>
         /// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
-        /// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
+        /// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
         /// <returns>the <see cref="V1OwnerReference"/> that matches the given object, or null if no matching reference exists.</returns>
         public static V1OwnerReference GetOwnerReference(
             this IMetadata<V1ObjectMeta> obj,
@@ -400,7 +400,7 @@ namespace k8s.Models
         /// any were removed.
         /// </summary>
         /// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
-        /// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
+        /// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
         /// <returns>true if any were removed</returns>
         public static bool RemoveOwnerReferences(
             this IMetadata<V1ObjectMeta> obj,

src/KubernetesClient/StreamDemuxer.cs

@@ -7,13 +7,13 @@ namespace k8s
     /// <summary>
     /// <para>
     ///     The <see cref="StreamDemuxer"/> allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command
-    ///     by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
+    ///     by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
-    ///     or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
+    ///     or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
-    ///     will return you a <see cref="WebSocket"/> connection.
+    ///     will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
     /// </para>
     /// <para>
-    ///     Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
+    ///     Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
-    ///     allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
+    ///     allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
     /// </para>
     /// </summary>
     public class StreamDemuxer : IStreamDemuxer

src/LibKubernetesGenerator/templates/Model.cs.template

@@ -61,9 +61,7 @@ namespace k8s.Models
         /// <summary>
         /// Validate the object.
         /// </summary>
-        /// <exception cref="ValidationException">
+
-        /// Thrown if validation fails
-        /// </exception>
         public virtual void Validate()
         {
             {{ for property in properties }}