regenerate apiref for web site

.pre-commit-config.yaml

@@ -11,6 +11,11 @@ repos:
     entry: make lint-fix
     language: system
     pass_filenames: false
+  - id: generate-apiref
+    name: generate-apiref
+    entry: make generate-apiref
+    language: system
+    pass_filenames: false
 - repo: https://github.com/google/yamlfmt
   rev: v0.10.0
   hooks:
@@ -20,7 +25,8 @@ repos:
   rev: v4.5.0
   hooks:
   - id: trailing-whitespace
+    exclude: site/_pages/appwrapper.v1beta2.md
   - id: end-of-file-fixer
-    exclude: hack/boilerplate.go.txt
+    exclude: hack/boilerplate.go.txt|site/_pages/appwrapper.v1beta2.md
   - id: mixed-line-ending
     args: ["--fix=lf"]

site/_pages/appwrapper.v1beta2.md

@@ -2,13 +2,22 @@
 permalink: /api/workload.codeflare.dev/v1beta2/
 title: AppWrapper API
 classes: wide
+description: Generated API reference documentation for workload.codeflare.dev/v1beta2.
 ---
 
 
-Generated API reference documentation for <no value>.
-
 ## Resource Types
 
+- [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper)
+- [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent)
+- [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus)
+- [AppWrapperCondition](#workload-codeflare-dev-v1beta2-AppWrapperCondition)
+- [AppWrapperList](#workload-codeflare-dev-v1beta2-AppWrapperList)
+- [AppWrapperPhase](#workload-codeflare-dev-v1beta2-AppWrapperPhase)
+- [AppWrapperPodSet](#workload-codeflare-dev-v1beta2-AppWrapperPodSet)
+- [AppWrapperPodSetInfo](#workload-codeflare-dev-v1beta2-AppWrapperPodSetInfo)
+- [AppWrapperSpec](#workload-codeflare-dev-v1beta2-AppWrapperSpec)
+- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus)
 
 
 ## `AppWrapper`     {#workload-codeflare-dev-v1beta2-AppWrapper}
@@ -69,7 +78,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 <a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
 </td>
 <td>
-   <p>PodSets contained in the Component</p>
+   <p>DeclaredPodSets for the Component (optional for known PodCreating GVKs)</p>
 </td>
 </tr>
 <tr><td><code>podSetInfos</code><br/>
@@ -89,6 +98,64 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 </tbody>
 </table>
 
+## `AppWrapperComponentStatus`     {#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus}
+
+
+**Appears in:**
+
+- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus)
+
+
+<p>AppWrapperComponentStatus tracks the status of a single managed Component</p>
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>name</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Name is the name of the Component</p>
+</td>
+</tr>
+<tr><td><code>kind</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Kind is the Kind of the Component</p>
+</td>
+</tr>
+<tr><td><code>apiVersion</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>APIVersion is the APIVersion of the Component</p>
+</td>
+</tr>
+<tr><td><code>podSets</code> <B>[Required]</B><br/>
+<a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
+</td>
+<td>
+   <p>PodSets is the validated PodSets for the Component (either from AppWrapperComponent.DeclaredPodSets or inferred by the controller)</p>
+</td>
+</tr>
+<tr><td><code>conditions</code><br/>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta"><code>[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition</code></a>
+</td>
+<td>
+   <p>Conditions hold the latest available observations of the Component's current state.</p>
+<p>The type of the condition could be:</p>
+<ul>
+<li>ResourcesDeployed: The component is deployed on the cluster</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+
 ## `AppWrapperPhase`     {#workload-codeflare-dev-v1beta2-AppWrapperPhase}
 
 (Alias of `string`)
@@ -110,6 +177,8 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 
 - [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent)
 
+- [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus)
+
 
 <p>AppWrapperPodSet describes an homogeneous set of pods</p>
 
@@ -133,6 +202,14 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
    <p>Path is the path Component.Template to the PodTemplateSpec for this PodSet</p>
 </td>
 </tr>
+<tr><td><code>annotations</code><br/>
+<code>map[string]string</code>
+</td>
+<td>
+   <p>Annotations is an unstructured key value map that may be used to store and retrieve
+arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.</p>
+</td>
+</tr>
 </tbody>
 </table>
 
@@ -180,6 +257,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
    <p>Tolerations to be added to the PodSpecTemplate</p>
 </td>
 </tr>
+<tr><td><code>schedulingGates</code><br/>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podschedulinggate-v1-core"><code>[]k8s.io/api/core/v1.PodSchedulingGate</code></a>
+</td>
+<td>
+   <p>SchedulingGates to be added to the PodSpecTemplate</p>
+</td>
+</tr>
 </tbody>
 </table>
 
@@ -213,6 +297,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
    <p>Suspend suspends the AppWrapper when set to true</p>
 </td>
 </tr>
+<tr><td><code>managedBy</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>ManagedBy is used to indicate the controller or entity that manages the AppWrapper.</p>
+</td>
+</tr>
 </tbody>
 </table>
 
@@ -261,5 +352,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap
 </ul>
 </td>
 </tr>
+<tr><td><code>componentStatus</code> <B>[Required]</B><br/>
+<a href="#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus"><code>[]AppWrapperComponentStatus</code></a>
+</td>
+<td>
+   <p>ComponentStatus parallels the Components array in the Spec and tracks the actually deployed resources</p>
+</td>
+</tr>
 </tbody>
 </table>
+

site/genref/markdown/members.tpl

@@ -1,5 +1,5 @@
 {{ define "members" }}
-  {{/* . is a apiType */}}
+{{/* . is a apiType */}}
   {{- range .GetMembers -}}
     {{/* . is a apiMember */}}
     {{- if not .Hidden }}

site/genref/markdown/pkg.tpl

@@ -6,21 +6,18 @@
 permalink: /api/{{ .DisplayName }}/
 title: {{ .Title }}
 classes: wide
+description: Generated API reference documentation for {{ .DisplayName }}.
 ---
 {{ .GetComment -}}
   {{- end -}}
 {{- end }}
 
-Generated API reference documentation for {{ .GroupName }}.
-
 ## Resource Types
 
 {{ range .packages -}}
-  {{- range .VisibleTypes -}}
-    {{- if .IsExported }}
+{{- range .VisibleTypes -}}
 - [{{ .DisplayName }}]({{ .Link }})
-    {{- end -}}
-  {{- end -}}
+{{ end -}}
 {{- end -}}
 
 {{ range .packages -}}
@@ -33,9 +30,8 @@ Generated API reference documentation for {{ .GroupName }}.
     {{ end }}
   {{ else }}
     {{/* For package w/o group name, list only types referenced. */}}
-    {{ $isConfig := (eq .GroupName "") }}
     {{- range .VisibleTypes -}}
-      {{- if or .Referenced $isConfig -}}
+      {{- if .Referenced -}}
 {{ template "type" . }}
       {{- end -}}
     {{- end }}

site/genref/markdown/type.tpl

@@ -22,13 +22,12 @@
 <table class="table">
 <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
 <tbody>
-    {{/* . is a apiType */}}
-    {{- if .IsExported -}}
+{{/* . is a apiType */}}
+{{- if .IsExported -}}
 {{/* Add apiVersion and kind rows if deemed necessary */}}
 <tr><td><code>apiVersion</code><br/>string</td><td><code>{{- .APIGroup -}}</code></td></tr>
 <tr><td><code>kind</code><br/>string</td><td><code>{{- .Name.Name -}}</code></td></tr>
-    {{ end -}}
-
+{{- end -}}
 {{/* The actual list of members is in the following template */}}
 {{- template "members" . -}}
 </tbody>