Add docs publishing workflow

- Fix type refs in docs - Added missing networking section - Add GH workflow to publish docs
ironcore-dev · Dec 14, 2022 · 5b569b0 · 5b569b0
1 parent 2fe1607
commit 5b569b0
Show file tree

Hide file tree

Showing 15 changed files with 216 additions and 179 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,23 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 'pypy3.9'
+      - uses: actions/cache@v3
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - name: Deploy docs
+        uses: afritzler/mkdocs-gh-pages-action@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/README.md b/docs/README.md
@@ -1,15 +1,6 @@
 # OnMetal API Documentation
 
 This page contains the documentation of the [onmetal-api](https://github.com/onmetal/onmetal-api) project which is part 
-of the the [onmetal](https://github.com/onmetal) project.
+of the [onmetal](https://github.com/onmetal) project.
 
-``` mermaid
-graph LR
-  A[Start] --> B{Error?};
-  B -->|Yes| C[Hmm...];
-  C --> D[Debug];
-  D --> B;
-  B ---->|No| E[Yay!];
-```
-
---8<-- "hack/docs/abbreviations.md"
+--8<-- "hack/docs/abbreviations.md"
diff --git a/docs/api-reference/compute.md b/docs/api-reference/compute.md
@@ -168,7 +168,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>ignitionRef</code><br/>
 <em>
-<a href="/api-reference/common.md#secretkeyselector">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.SecretKeySelector">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.SecretKeySelector
 </a>
 </em>
@@ -196,7 +196,7 @@ If key is empty, DefaultIgnitionKey will be used as fallback.</p>
 <td>
 <code>tolerations</code><br/>
 <em>
-<a href="/api-reference/common.md#toleration">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.Toleration">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.Toleration
 </a>
 </em>
@@ -353,7 +353,7 @@ string
 <td>
 <code>taints</code><br/>
 <em>
-<a href="/api-reference/common.md#taint">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.Taint">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.Taint
 </a>
 </em>
@@ -515,7 +515,7 @@ object) networking.NetworkInterface.</p>
 <td>
 <code>networkInterfaceTemplate</code><br/>
 <em>
-<a href="/api-reference/networking.md#networking.api.onmetal.de/v1alpha1.NetworkInterfaceTemplateSpec">
+<a href="/api-reference/networking/#networking.api.onmetal.de/v1alpha1.NetworkInterfaceTemplateSpec">
 github.com/onmetal/onmetal-api/api/networking/v1alpha1.NetworkInterfaceTemplateSpec
 </a>
 </em>
@@ -547,7 +547,7 @@ storage.Volume.</p>
 <td>
 <code>volumeTemplate</code><br/>
 <em>
-<a href="/api-reference/storage.md#storage.api.onmetal.de/v1alpha1.VolumeTemplateSpec">
+<a href="/api-reference/storage/#storage.api.onmetal.de/v1alpha1.VolumeTemplateSpec">
 github.com/onmetal/onmetal-api/api/storage/v1alpha1.VolumeTemplateSpec
 </a>
 </em>
@@ -825,7 +825,7 @@ string
 <td>
 <code>taints</code><br/>
 <em>
-<a href="/api-reference/common.md#taint">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.Taint">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.Taint
 </a>
 </em>
@@ -1055,7 +1055,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>ignitionRef</code><br/>
 <em>
-<a href="/api-reference/common.md#secretkeyselector">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.SecretKeySelector">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.SecretKeySelector
 </a>
 </em>
@@ -1083,7 +1083,7 @@ If key is empty, DefaultIgnitionKey will be used as fallback.</p>
 <td>
 <code>tolerations</code><br/>
 <em>
-<a href="/api-reference/common.md#toleration">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.Toleration">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.Toleration
 </a>
 </em>
@@ -1382,7 +1382,7 @@ string
 <td>
 <code>ips</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.IP
 </a>
 </em>
@@ -1395,7 +1395,7 @@ string
 <td>
 <code>virtualIP</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IP
 </a>
 </em>

diff --git a/docs/api-reference/ipam.md b/docs/api-reference/ipam.md
@@ -48,7 +48,7 @@ string
 <td>
 <code>metadata</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -75,7 +75,7 @@ PrefixSpec
 <td>
 <code>ipFamily</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ipfamily-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#ipfamily-v1-core">
 Kubernetes core/v1.IPFamily
 </a>
 </em>
@@ -89,7 +89,7 @@ If unset but Prefix is set, this can be inferred.</p>
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -113,7 +113,7 @@ int32
 <td>
 <code>parentRef</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#localobjectreference-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -128,7 +128,7 @@ allocated by itself.</p>
 <td>
 <code>parentSelector</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#labelselector-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
 Kubernetes meta/v1.LabelSelector
 </a>
 </em>
@@ -188,7 +188,7 @@ string
 <td>
 <code>metadata</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -215,7 +215,7 @@ PrefixAllocationSpec
 <td>
 <code>ipFamily</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ipfamily-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#ipfamily-v1-core">
 Kubernetes core/v1.IPFamily
 </a>
 </em>
@@ -229,7 +229,7 @@ If unset but Prefix is set, this can be inferred.</p>
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -253,7 +253,7 @@ int32
 <td>
 <code>prefixRef</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#localobjectreference-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -266,7 +266,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>prefixSelector</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#labelselector-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
 Kubernetes meta/v1.LabelSelector
 </a>
 </em>
@@ -338,7 +338,7 @@ PrefixAllocationStatus
 <td>
 <code>ipFamily</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ipfamily-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#ipfamily-v1-core">
 Kubernetes core/v1.IPFamily
 </a>
 </em>
@@ -352,7 +352,7 @@ If unset but Prefix is set, this can be inferred.</p>
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -376,7 +376,7 @@ int32
 <td>
 <code>prefixRef</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#localobjectreference-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -389,7 +389,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>prefixSelector</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#labelselector-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
 Kubernetes meta/v1.LabelSelector
 </a>
 </em>
@@ -420,7 +420,7 @@ Kubernetes meta/v1.LabelSelector
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -446,7 +446,7 @@ PrefixAllocationPhase
 <td>
 <code>lastPhaseTransitionTime</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
 Kubernetes meta/v1.Time
 </a>
 </em>
@@ -500,7 +500,7 @@ Kubernetes meta/v1.Time
 <td>
 <code>ipFamily</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ipfamily-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#ipfamily-v1-core">
 Kubernetes core/v1.IPFamily
 </a>
 </em>
@@ -514,7 +514,7 @@ If unset but Prefix is set, this can be inferred.</p>
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -538,7 +538,7 @@ int32
 <td>
 <code>parentRef</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#localobjectreference-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -553,7 +553,7 @@ allocated by itself.</p>
 <td>
 <code>parentSelector</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#labelselector-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
 Kubernetes meta/v1.LabelSelector
 </a>
 </em>
@@ -597,7 +597,7 @@ PrefixPhase
 <td>
 <code>lastPhaseTransitionTime</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#time-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta">
 Kubernetes meta/v1.Time
 </a>
 </em>
@@ -610,7 +610,7 @@ Kubernetes meta/v1.Time
 <td>
 <code>used</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 []github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -637,7 +637,7 @@ Kubernetes meta/v1.Time
 <td>
 <code>metadata</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -664,7 +664,7 @@ PrefixSpec
 <td>
 <code>ipFamily</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ipfamily-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#ipfamily-v1-core">
 Kubernetes core/v1.IPFamily
 </a>
 </em>
@@ -678,7 +678,7 @@ If unset but Prefix is set, this can be inferred.</p>
 <td>
 <code>prefix</code><br/>
 <em>
-<a href="/api-reference/common.md#ip">
+<a href="/api-reference/common/#common.api.onmetal.de/v1alpha1.IP">
 github.com/onmetal/onmetal-api/api/common/v1alpha1.IPPrefix
 </a>
 </em>
@@ -702,7 +702,7 @@ int32
 <td>
 <code>parentRef</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#localobjectreference-v1-core">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -717,7 +717,7 @@ allocated by itself.</p>
 <td>
 <code>parentSelector</code><br/>
 <em>
-<a href="https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#labelselector-v1-meta">
+<a href="https://v1-25.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#labelselector-v1-meta">
 Kubernetes meta/v1.LabelSelector
 </a>
 </em>