Skip to content

Commit 185d516

Browse files
dgrove-ossdgrove-oss
authored
minor website improvements (#92)
1 parent 7d22ca9 commit 185d516

File tree

6 files changed

+49
-74
lines changed

6 files changed

+49
-74
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Read the [Quick Start Guide](https://project-codeflare.github.io/appwrapper/quic
4646
## Usage
4747

4848
For example of AppWrapper usage, browse our [Samples](./samples) directory or
49-
see the [Examples](https://project-codeflare.github.io/appwrapper/examples/) section
49+
see the [Samples](https://project-codeflare.github.io/appwrapper/samples/) section
5050
of the project website.
5151

5252
## Development

‎api/v1beta2/appwrapper_types.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ const (
110110
//+kubebuilder:object:root=true
111111
//+kubebuilder:subresource:status
112112
//+kubebuilder:printcolumn:name="Status",type="string",JSONPath=`.status.phase`
113+
//+kubebuilder:resource:shortName={appwrapper,appwrappers}
113114

114115
// AppWrapper is the Schema for the appwrappers API
115116
type AppWrapper struct {

‎api/v1beta2/doc.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/*
2+
Copyright 2024 IBM Corporation.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
// +kubebuilder:object:generate=true
18+
// +groupName=workload.codeflare.dev
19+
package v1beta2

‎site/_data/navigation.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ main:
66
- title: "Samples"
77
url: /samples/
88
- title: "API Reference"
9-
url: /api/v1beta2/
9+
url: /api/workload.codeflare.dev/v1beta2/
1010

1111

1212
side:
@@ -27,7 +27,7 @@ side:
2727
- title: "Architecture"
2828
children:
2929
- title: API Reference
30-
url: /api/v1beta2/
30+
url: /api/workload.codeflare.dev/v1beta2/
3131
- title: Controllers
3232
url: /arch-controller/
3333
- title: Fault Tolerance

‎site/_pages/appwrapper.v1beta2.md‎

Lines changed: 20 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
permalink: /api/v1beta2/
2+
permalink: /api/workload.codeflare.dev/v1beta2/
33
title: AppWrapper API
44
classes: wide
55
---
@@ -9,21 +9,9 @@ Generated API reference documentation for <no value>.
99

1010
## Resource Types
1111

12-
- [AppWrapper](#AppWrapper)
13-
- [AppWrapperComponent](#AppWrapperComponent)
14-
- [AppWrapperCondition](#AppWrapperCondition)
15-
- [AppWrapperList](#AppWrapperList)
16-
- [AppWrapperPhase](#AppWrapperPhase)
17-
- [AppWrapperPodSet](#AppWrapperPodSet)
18-
- [AppWrapperPodSetInfo](#AppWrapperPodSetInfo)
19-
- [AppWrapperSpec](#AppWrapperSpec)
20-
- [AppWrapperStatus](#AppWrapperStatus)
2112

2213

23-
24-
25-
26-
## `AppWrapper` {#AppWrapper}
14+
## `AppWrapper` {#workload-codeflare-dev-v1beta2-AppWrapper}
2715

2816

2917
**Appears in:**
@@ -39,26 +27,26 @@ Generated API reference documentation for <no value>.
3927

4028

4129
<tr><td><code>spec</code> <B>[Required]</B><br/>
42-
<a href="#AppWrapperSpec"><code>AppWrapperSpec</code></a>
30+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperSpec"><code>AppWrapperSpec</code></a>
4331
</td>
4432
<td>
4533
<span class="text-muted">No description provided.</span></td>
4634
</tr>
4735
<tr><td><code>status</code> <B>[Required]</B><br/>
48-
<a href="#AppWrapperStatus"><code>AppWrapperStatus</code></a>
36+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperStatus"><code>AppWrapperStatus</code></a>
4937
</td>
5038
<td>
5139
<span class="text-muted">No description provided.</span></td>
5240
</tr>
5341
</tbody>
5442
</table>
5543

56-
## `AppWrapperComponent` {#AppWrapperComponent}
44+
## `AppWrapperComponent` {#workload-codeflare-dev-v1beta2-AppWrapperComponent}
5745

5846

5947
**Appears in:**
6048

61-
- [AppWrapperSpec](#AppWrapperSpec)
49+
- [AppWrapperSpec](#workload-codeflare-dev-v1beta2-AppWrapperSpec)
6250

6351

6452
<p>AppWrapperComponent describes a wrapped resource</p>
@@ -70,14 +58,14 @@ Generated API reference documentation for <no value>.
7058

7159

7260
<tr><td><code>podSets</code> <B>[Required]</B><br/>
73-
<a href="#AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
61+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSet"><code>[]AppWrapperPodSet</code></a>
7462
</td>
7563
<td>
7664
<p>PodSets contained in the component</p>
7765
</td>
7866
</tr>
7967
<tr><td><code>podSetInfos</code> <B>[Required]</B><br/>
80-
<a href="#AppWrapperPodSetInfo"><code>[]AppWrapperPodSetInfo</code></a>
68+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperPodSetInfo"><code>[]AppWrapperPodSetInfo</code></a>
8169
</td>
8270
<td>
8371
<p>PodSetInfos assigned to the Component by Kueue</p>
@@ -93,61 +81,26 @@ Generated API reference documentation for <no value>.
9381
</tbody>
9482
</table>
9583

96-
## `AppWrapperCondition` {#AppWrapperCondition}
97-
98-
(Alias of `string`)
99-
100-
101-
102-
103-
104-
## `AppWrapperList` {#AppWrapperList}
105-
106-
107-
108-
<p>AppWrapperList contains a list of appwrappers</p>
109-
110-
111-
<table class="table">
112-
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
113-
<tbody>
114-
115-
116-
<tr><td><code>metadata</code> <B>[Required]</B><br/>
117-
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta"><code>k8s.io/apimachinery/pkg/apis/meta/v1.ListMeta</code></a>
118-
</td>
119-
<td>
120-
<span class="text-muted">No description provided.</span></td>
121-
</tr>
122-
<tr><td><code>items</code> <B>[Required]</B><br/>
123-
<a href="#AppWrapper"><code>[]AppWrapper</code></a>
124-
</td>
125-
<td>
126-
<span class="text-muted">No description provided.</span></td>
127-
</tr>
128-
</tbody>
129-
</table>
130-
131-
## `AppWrapperPhase` {#AppWrapperPhase}
84+
## `AppWrapperPhase` {#workload-codeflare-dev-v1beta2-AppWrapperPhase}
13285

13386
(Alias of `string`)
13487

13588
**Appears in:**
13689

137-
- [AppWrapperStatus](#AppWrapperStatus)
90+
- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus)
13891

13992

14093
<p>AppWrapperPhase is the phase of the appwrapper</p>
14194

14295

14396

14497

145-
## `AppWrapperPodSet` {#AppWrapperPodSet}
98+
## `AppWrapperPodSet` {#workload-codeflare-dev-v1beta2-AppWrapperPodSet}
14699

147100

148101
**Appears in:**
149102

150-
- [AppWrapperComponent](#AppWrapperComponent)
103+
- [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent)
151104

152105

153106
<p>AppWrapperPodSet describes an homogeneous set of pods</p>
@@ -175,12 +128,12 @@ Generated API reference documentation for <no value>.
175128
</tbody>
176129
</table>
177130

178-
## `AppWrapperPodSetInfo` {#AppWrapperPodSetInfo}
131+
## `AppWrapperPodSetInfo` {#workload-codeflare-dev-v1beta2-AppWrapperPodSetInfo}
179132

180133

181134
**Appears in:**
182135

183-
- [AppWrapperComponent](#AppWrapperComponent)
136+
- [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent)
184137

185138

186139

@@ -216,12 +169,12 @@ Generated API reference documentation for <no value>.
216169
</tbody>
217170
</table>
218171

219-
## `AppWrapperSpec` {#AppWrapperSpec}
172+
## `AppWrapperSpec` {#workload-codeflare-dev-v1beta2-AppWrapperSpec}
220173

221174

222175
**Appears in:**
223176

224-
- [AppWrapper](#AppWrapper)
177+
- [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper)
225178

226179

227180
<p>AppWrapperSpec defines the desired state of the appwrapper</p>
@@ -233,7 +186,7 @@ Generated API reference documentation for <no value>.
233186

234187

235188
<tr><td><code>components</code> <B>[Required]</B><br/>
236-
<a href="#AppWrapperComponent"><code>[]AppWrapperComponent</code></a>
189+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperComponent"><code>[]AppWrapperComponent</code></a>
237190
</td>
238191
<td>
239192
<p>Components lists the components in the job</p>
@@ -249,12 +202,12 @@ Generated API reference documentation for <no value>.
249202
</tbody>
250203
</table>
251204

252-
## `AppWrapperStatus` {#AppWrapperStatus}
205+
## `AppWrapperStatus` {#workload-codeflare-dev-v1beta2-AppWrapperStatus}
253206

254207

255208
**Appears in:**
256209

257-
- [AppWrapper](#AppWrapper)
210+
- [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper)
258211

259212

260213
<p>AppWrapperStatus defines the observed state of the appwrapper</p>
@@ -266,7 +219,7 @@ Generated API reference documentation for <no value>.
266219

267220

268221
<tr><td><code>phase</code> <B>[Required]</B><br/>
269-
<a href="#AppWrapperPhase"><code>AppWrapperPhase</code></a>
222+
<a href="#workload-codeflare-dev-v1beta2-AppWrapperPhase"><code>AppWrapperPhase</code></a>
270223
</td>
271224
<td>
272225
<p>Phase of the AppWrapper object</p>

‎site/genref/markdown/pkg.tpl‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,27 @@
33
{{- range $idx, $val := .packages -}}
44
{{- if .IsMain -}}
55
---
6-
permalink: /api{{ .DisplayName }}/
6+
permalink: /api/{{ .DisplayName }}/
77
title: {{ .Title }}
88
classes: wide
99
---
1010
{{ .GetComment -}}
1111
{{- end -}}
1212
{{- end }}
1313

14-
Generated API reference documentation for {{ .DisplayName }}.
14+
Generated API reference documentation for {{ .GroupName }}.
1515

1616
## Resource Types
1717

1818
{{ range .packages -}}
1919
{{- range .VisibleTypes -}}
20+
{{- if .IsExported }}
2021
- [{{ .DisplayName }}]({{ .Link }})
21-
{{ end }}
22+
{{- end -}}
23+
{{- end -}}
2224
{{- end -}}
2325

24-
{{ range .packages }}
26+
{{ range .packages -}}
2527
{{ if ne .GroupName "" -}}
2628
{{/* For package with a group name, list all type definitions in it. */}}
2729
{{- range .VisibleTypes }}

0 commit comments

Comments
 (0)