Skip to content

Commit 0deebb1

Browse files
authored
Merge pull request #526 from redis/fix-k8s-api-docs-generation
Fix k8s api docs generation
2 parents 14a8460 + 1178e25 commit 0deebb1

File tree

3 files changed

+26
-18
lines changed

3 files changed

+26
-18
lines changed

.github/workflows/k8s_apis_sync.yaml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,30 @@ jobs:
5555
crdoc --resources crds/reaadb_crd.yaml --output artifacts/redis_enterprise_active_active_database_api.md --template templates/template.tmpl
5656
sed -E -i 's/^### RedisEnterpriseActiveActiveDatabase\./### /g' artifacts/redis_enterprise_active_active_database_api.md
5757
sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseactiveactivedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_active_active_database_api.md
58-
sed -E -i 's/<td><b><a href="#redisenterpriseactiveactivedatabase/<td><b><a href="#/' artifacts/redis_enterprise_active_active_database_api.md
58+
sed -E -i 's/<td><a href="#redisenterpriseactiveactivedatabase/<td><a href="#/' artifacts/redis_enterprise_active_active_database_api.md
59+
sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_active_active_database_api.md
60+
awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_active_active_database_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_active_active_database_api.md
5961
6062
crdoc --resources crds/rec_crd.yaml --output artifacts/redis_enterprise_cluster_api.md --template templates/template.tmpl
6163
sed -E -i 's/^### RedisEnterpriseCluster\./### /g' artifacts/redis_enterprise_cluster_api.md
6264
sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_cluster_api.md
63-
sed -E -i 's/<td><b><a href="#redisenterprisecluster/<td><b><a href="#/' artifacts/redis_enterprise_cluster_api.md
65+
sed -E -i 's/<td><a href="#redisenterprisecluster/<td><a href="#/' artifacts/redis_enterprise_cluster_api.md
66+
sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_cluster_api.md
67+
awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_cluster_api.md
6468
6569
crdoc --resources crds/redb_crd.yaml --output artifacts/redis_enterprise_database_api.md --template templates/template.tmpl
6670
sed -E -i 's/^### RedisEnterpriseDatabase\./### /g' artifacts/redis_enterprise_database_api.md
6771
sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_database_api.md
68-
sed -E -i 's/<td><b><a href="#redisenterprisedatabase/<td><b><a href="#/' artifacts/redis_enterprise_database_api.md
72+
sed -E -i 's/<td><a href="#redisenterprisedatabase/<td><a href="#/' artifacts/redis_enterprise_database_api.md
73+
sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_database_api.md
74+
awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_database_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_database_api.md
6975
70-
crdoc --resources crds/rerc_crd.yaml --output artifacts/redis_enterprise_remote_cluster.md --template templates/template.tmpl
71-
sed -E -i 's/^### RedisEnterpriseRemoteCluster\./### /g' artifacts/redis_enterprise_remote_cluster.md
72-
sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseremotecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_remote_cluster.md
73-
sed -E -i 's/<td><b><a href="#redisenterpriseremotecluster/<td><b><a href="#/' artifacts/redis_enterprise_remote_cluster.md
76+
crdoc --resources crds/rerc_crd.yaml --output artifacts/redis_enterprise_remote_cluster_api.md --template templates/template.tmpl
77+
sed -E -i 's/^### RedisEnterpriseRemoteCluster\./### /g' artifacts/redis_enterprise_remote_cluster_api.md
78+
sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseremotecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_remote_cluster_api.md
79+
sed -E -i 's/<td><a href="#redisenterpriseremotecluster/<td><a href="#/' artifacts/redis_enterprise_remote_cluster_api.md
80+
sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_remote_cluster_api.md
81+
awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_remote_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_remote_cluster_api.md
7482
7583
- name: 'Send pull request'
7684
env:
@@ -88,7 +96,7 @@ jobs:
8896
cp artifacts/redis_enterprise_active_active_database_api.md content/operate/kubernetes/reference/
8997
cp artifacts/redis_enterprise_cluster_api.md content/operate/kubernetes/reference/
9098
cp artifacts/redis_enterprise_database_api.md content/operate/kubernetes/reference/
91-
cp artifacts/redis_enterprise_remote_cluster.md content/operate/kubernetes/reference/
99+
cp artifacts/redis_enterprise_remote_cluster_api.md content/operate/kubernetes/reference/
92100
93101
git apply content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch
94102

content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ index 970ba528..6afe4c50 100644
2525
+aliases: [ /operate/kubernetes/reference/cluster-options, ]
2626
---
2727

28-
Packages:
28+
apiVersion:
2929
diff --git a/content/operate/kubernetes/reference/redis_enterprise_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_database_api.md
3030
index f925ce44..ea21766e 100644
3131
--- a/content/operate/kubernetes/reference/redis_enterprise_database_api.md
@@ -40,11 +40,11 @@ index f925ce44..ea21766e 100644
4040
+aliases: [ /operate/kubernetes/reference/db-options, ]
4141
---
4242

43-
Packages:
44-
diff --git a/content/operate/kubernetes/reference/redis_enterprise_remote_cluster.md b/content/operate/kubernetes/reference/redis_enterprise_remote_cluster.md
43+
apiVersion:
44+
diff --git a/content/operate/kubernetes/reference/redis_enterprise_remote_cluster_api.md b/content/operate/kubernetes/reference/redis_enterprise_remote_cluster_api.md
4545
index 7d37a6dc..a9a313cf 100644
46-
--- a/content/operate/kubernetes/reference/redis_enterprise_remote_cluster.md
47-
+++ b/content/operate/kubernetes/reference/redis_enterprise_remote_cluster.md
46+
--- a/content/operate/kubernetes/reference/redis_enterprise_remote_cluster_api.md
47+
+++ b/content/operate/kubernetes/reference/redis_enterprise_remote_cluster_api.md
4848
@@ -5,7 +5,7 @@ categories:
4949
- docs
5050
- operate

content/operate/kubernetes/reference/kubernetes-api-reference-template.tmpl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ linkTitle: {{ $title }}
1313
weight: 30
1414
---
1515

16-
Packages:
16+
apiVersion:
1717
{{ $group:= index .Groups 0 }}
1818

1919
- [{{$group.Group}}/{{$group.Version}}](#{{ anchorize (printf "%s/%s" $group.Group $group.Version) }})
@@ -45,27 +45,27 @@ Packages:
4545
<tbody>
4646
{{- if .IsTopLevel -}}
4747
<tr>
48-
<td><b>apiVersion</b></td>
48+
<td>apiVersion</td>
4949
<td>string</td>
5050
<td>{{$group.Group}}/{{$group.Version}}</td>
5151
<td>true</td>
5252
</tr>
5353
<tr>
54-
<td><b>kind</b></td>
54+
<td>kind</td>
5555
<td>string</td>
5656
<td>{{$kind.Name}}</td>
5757
<td>true</td>
5858
</tr>
5959
<tr>
60-
<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></b></td>
60+
<td><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></td>
6161
<td>object</td>
6262
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
6363
<td>true</td>
6464
</tr>
6565
{{- end -}}
6666
{{- range .Fields -}}
6767
<tr>
68-
<td><b>{{if .TypeKey}}<a href="#{{.TypeKey}}">{{.Name}}</a>{{else}}{{.Name}}{{end}}</b></td>
68+
<td>{{if .TypeKey}}<a href="#{{.TypeKey}}">{{.Name}}</a>{{else}}{{.Name}}{{end}}</td>
6969
<td>{{.Type}}</td>
7070
<td>
7171
{{.Description}}<br/>

0 commit comments

Comments
 (0)