From 1e7414d662715f2ec7b871d252239e823bf8a375 Mon Sep 17 00:00:00 2001
From: Pavol Loffay <p.loffay@gmail.com>
Date: Tue, 25 Jul 2023 15:18:31 +0200
Subject: [PATCH] Publish API docs only as a md file (#521)

* Publish API docs only as a md file

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>

* Fix

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>

---------

Signed-off-by: Pavol Loffay <p.loffay@gmail.com>
---
 Makefile                       |  4 ---
 config/docs/templates/pkg.tpl  | 12 -------
 docs/operator/api.md           | 62 ++--------------------------------
 docs/operator/feature-gates.md | 15 +-------
 4 files changed, 3 insertions(+), 90 deletions(-)

diff --git a/Makefile b/Makefile
index 5abc40433..378f0bd56 100644
--- a/Makefile
+++ b/Makefile
@@ -450,10 +450,6 @@ api-docs: docs/operator/api.md docs/operator/feature-gates.md
 TYPES_TARGET := $(shell find apis/tempo -type f -iname "*_types.go")
 docs/operator/api.md: $(TYPES_TARGET) gen-crd-api-reference-docs
 	$(GEN_CRD) -api-dir "github.com/grafana/tempo-operator/apis/tempo/" -config "$(PWD)/config/docs/config.json" -template-dir "$(PWD)/config/docs/templates" -out-file "$(PWD)/$@"
-	sed -i 's/+docs:/  docs:/' $@
-	sed -i 's/+parent:/    parent:/' $@
-	sed -i 's/##/\n##/' $@
-	sed -i 's/+newline/\n/' $@
 
 
 FEATURE_GATES_TARGET := $(shell find apis/config -type f -iname "*_types.go")
diff --git a/config/docs/templates/pkg.tpl b/config/docs/templates/pkg.tpl
index e933b3711..108eb311d 100644
--- a/config/docs/templates/pkg.tpl
+++ b/config/docs/templates/pkg.tpl
@@ -1,16 +1,4 @@
 {{ define "packages" }}
----
-title: "API"
-description: "Generated API docs for the Tempo Operator"
-lead: ""
-draft: false
-images: []
-menu:
-+docs:
-+parent: "operator"
-weight: 1000
-toc: true
----
 
 This Document contains the types introduced by the Tempo Operator to be consumed by users.
 
diff --git a/docs/operator/api.md b/docs/operator/api.md
index fa3763670..a2a86c5e1 100644
--- a/docs/operator/api.md
+++ b/docs/operator/api.md
@@ -1,17 +1,4 @@
-
----
-title: "API"
-description: "Generated API docs for the Tempo Operator"
-lead: ""
-draft: false
-images: []
-menu:
-  docs:
-    parent: "operator"
-weight: 1000
-toc: true
----
-
+
 This Document contains the types introduced by the Tempo Operator to be consumed by users.
 
 > This page is automatically generated with `gen-crd-api-reference-docs`.
@@ -26,7 +13,6 @@ This Document contains the types introduced by the Tempo Operator to be consumed
 
 <b>Resource Types:</b>
 
-
 ## AuthenticationSpec { #tempo-grafana-com-v1alpha1-AuthenticationSpec }
 
 <p>
@@ -130,7 +116,6 @@ OIDCSpec
 </tbody>
 </table>
 
-
 ## AuthorizationSpec { #tempo-grafana-com-v1alpha1-AuthorizationSpec }
 
 <p>
@@ -219,7 +204,6 @@ configuration per tenant for tempo Gateway component.</p>
 </tbody>
 </table>
 
-
 ## ComponentStatus { #tempo-grafana-com-v1alpha1-ComponentStatus }
 
 <p>
@@ -415,7 +399,6 @@ PodStatusMap
 </tbody>
 </table>
 
-
 ## ConditionReason { #tempo-grafana-com-v1alpha1-ConditionReason }
 
 (<code>string</code> alias)
@@ -488,7 +471,6 @@ PodStatusMap
 </tr></tbody>
 </table>
 
-
 ## ConditionStatus { #tempo-grafana-com-v1alpha1-ConditionStatus }
 
 (<code>string</code> alias)
@@ -536,7 +518,6 @@ PodStatusMap
 </tr></tbody>
 </table>
 
-
 ## Defaulter { #tempo-grafana-com-v1alpha1-Defaulter }
 
 <div>
@@ -587,7 +568,6 @@ Feature Gates.ProjectConfig
 </tbody>
 </table>
 
-
 ## IngestionLimitSpec { #tempo-grafana-com-v1alpha1-IngestionLimitSpec }
 
 <p>
@@ -713,7 +693,6 @@ int
 </tbody>
 </table>
 
-
 ## IngressSpec { #tempo-grafana-com-v1alpha1-IngressSpec }
 
 <p>
@@ -873,7 +852,6 @@ RouteSpec
 </tbody>
 </table>
 
-
 ## IngressType { #tempo-grafana-com-v1alpha1-IngressType }
 
 (<code>string</code> alias)
@@ -922,7 +900,6 @@ RouteSpec
 </tr></tbody>
 </table>
 
-
 ## JaegerQuerySpec { #tempo-grafana-com-v1alpha1-JaegerQuerySpec }
 
 <p>
@@ -1006,7 +983,6 @@ IngressSpec
 </tbody>
 </table>
 
-
 ## LimitSpec { #tempo-grafana-com-v1alpha1-LimitSpec }
 
 <p>
@@ -1094,7 +1070,6 @@ RateLimitSpec
 </tbody>
 </table>
 
-
 ## ManagementStateType { #tempo-grafana-com-v1alpha1-ManagementStateType }
 
 (<code>string</code> alias)
@@ -1140,7 +1115,6 @@ reconciled by the operator.</p>
 </tr></tbody>
 </table>
 
-
 ## MetricsConfigSpec { #tempo-grafana-com-v1alpha1-MetricsConfigSpec }
 
 <p>
@@ -1220,7 +1194,6 @@ bool
 </tbody>
 </table>
 
-
 ## ModeType { #tempo-grafana-com-v1alpha1-ModeType }
 
 (<code>string</code> alias)
@@ -1266,7 +1239,6 @@ using an in-process OpenPolicyAgent Rego authorizer.</p>
 </tr></tbody>
 </table>
 
-
 ## OIDCSpec { #tempo-grafana-com-v1alpha1-OIDCSpec }
 
 <p>
@@ -1419,7 +1391,6 @@ string
 </tbody>
 </table>
 
-
 ## ObjectStorageSecretSpec { #tempo-grafana-com-v1alpha1-ObjectStorageSecretSpec }
 
 <p>
@@ -1499,7 +1470,6 @@ string
 </tbody>
 </table>
 
-
 ## ObjectStorageSecretType { #tempo-grafana-com-v1alpha1-ObjectStorageSecretType }
 
 (<code>string</code> alias)
@@ -1548,7 +1518,6 @@ string
 </tr></tbody>
 </table>
 
-
 ## ObjectStorageSpec { #tempo-grafana-com-v1alpha1-ObjectStorageSpec }
 
 <p>
@@ -1636,7 +1605,6 @@ Name of a secret in the same namespace as the tempo TempoStack custom resource.<
 </tbody>
 </table>
 
-
 ## ObjectStorageTLSSpec { #tempo-grafana-com-v1alpha1-ObjectStorageTLSSpec }
 
 <p>
@@ -1694,7 +1662,6 @@ It needs to be in the same namespace as the Tempo custom resource.</p>
 </tbody>
 </table>
 
-
 ## ObservabilitySpec { #tempo-grafana-com-v1alpha1-ObservabilitySpec }
 
 <p>
@@ -1782,7 +1749,6 @@ TracingConfigSpec
 </tbody>
 </table>
 
-
 ## PermissionType { #tempo-grafana-com-v1alpha1-PermissionType }
 
 (<code>string</code> alias)
@@ -1826,7 +1792,6 @@ TracingConfigSpec
 </tr></tbody>
 </table>
 
-
 ## PodStatusMap { #tempo-grafana-com-v1alpha1-PodStatusMap }
 
 (<code>map[k8s.io/api/core/v1.PodPhase][]string</code> alias)
@@ -1843,7 +1808,6 @@ TracingConfigSpec
 
 </div>
 
-
 ## QueryLimit { #tempo-grafana-com-v1alpha1-QueryLimit }
 
 <p>
@@ -1953,7 +1917,6 @@ If this value is not set, then spec.search.maxDuration is used.</p>
 </tbody>
 </table>
 
-
 ## RateLimitSpec { #tempo-grafana-com-v1alpha1-RateLimitSpec }
 
 <p>
@@ -2041,7 +2004,6 @@ QueryLimit
 </tbody>
 </table>
 
-
 ## Resources { #tempo-grafana-com-v1alpha1-Resources }
 
 <p>
@@ -2105,7 +2067,6 @@ See <a href="http://github.com/grafana/tempo/issues/1540">http://github.com/graf
 </tbody>
 </table>
 
-
 ## RetentionConfig { #tempo-grafana-com-v1alpha1-RetentionConfig }
 
 <p>
@@ -2168,7 +2129,6 @@ default: value is 48h.</p>
 </tbody>
 </table>
 
-
 ## RetentionSpec { #tempo-grafana-com-v1alpha1-RetentionSpec }
 
 <p>
@@ -2256,7 +2216,6 @@ RetentionConfig
 </tbody>
 </table>
 
-
 ## RoleBindingsSpec { #tempo-grafana-com-v1alpha1-RoleBindingsSpec }
 
 <p>
@@ -2351,7 +2310,6 @@ string
 </tbody>
 </table>
 
-
 ## RoleSpec { #tempo-grafana-com-v1alpha1-RoleSpec }
 
 <p>
@@ -2465,7 +2423,6 @@ string
 </tbody>
 </table>
 
-
 ## RouteSpec { #tempo-grafana-com-v1alpha1-RouteSpec }
 
 <p>
@@ -2526,7 +2483,6 @@ TLSRouteTerminationType
 </tbody>
 </table>
 
-
 ## SearchSpec { #tempo-grafana-com-v1alpha1-SearchSpec }
 
 <p>
@@ -2635,7 +2591,6 @@ The default value of 0 disables this limit.</p>
 </tbody>
 </table>
 
-
 ## Subject { #tempo-grafana-com-v1alpha1-Subject }
 
 <p>
@@ -2711,7 +2666,6 @@ SubjectKind
 </tbody>
 </table>
 
-
 ## SubjectKind { #tempo-grafana-com-v1alpha1-SubjectKind }
 
 (<code>string</code> alias)
@@ -2755,7 +2709,6 @@ SubjectKind
 </tr></tbody>
 </table>
 
-
 ## TLSRouteTerminationType { #tempo-grafana-com-v1alpha1-TLSRouteTerminationType }
 
 (<code>string</code> alias)
@@ -2812,7 +2765,6 @@ and re-encrypt using a new certificate.</p>
 </tr></tbody>
 </table>
 
-
 ## TempoComponentSpec { #tempo-grafana-com-v1alpha1-TempoComponentSpec }
 
 <p>
@@ -2919,7 +2871,6 @@ map[string]string
 </tbody>
 </table>
 
-
 ## TempoGatewaySpec { #tempo-grafana-com-v1alpha1-TempoGatewaySpec }
 
 <p>
@@ -3029,7 +2980,6 @@ IngressSpec
 </tbody>
 </table>
 
-
 ## TempoQueryFrontendSpec { #tempo-grafana-com-v1alpha1-TempoQueryFrontendSpec }
 
 <p>
@@ -3120,7 +3070,6 @@ JaegerQuerySpec
 </tbody>
 </table>
 
-
 ## TempoStack { #tempo-grafana-com-v1alpha1-TempoStack }
 
 <div>
@@ -3221,7 +3170,6 @@ TempoStackSpec
 </tbody>
 </table>
 
-
 ## TempoStackSpec { #tempo-grafana-com-v1alpha1-TempoStackSpec }
 
 <p>
@@ -3618,7 +3566,6 @@ ObservabilitySpec
 </tbody>
 </table>
 
-
 ## TempoStackStatus { #tempo-grafana-com-v1alpha1-TempoStackStatus }
 
 <p>
@@ -3776,7 +3723,6 @@ per component.</p>
 </tbody>
 </table>
 
-
 ## TempoTemplateSpec { #tempo-grafana-com-v1alpha1-TempoTemplateSpec }
 
 <p>
@@ -3973,7 +3919,6 @@ TempoGatewaySpec
 </tbody>
 </table>
 
-
 ## TenantSecretSpec { #tempo-grafana-com-v1alpha1-TenantSecretSpec }
 
 <p>
@@ -4031,7 +3976,6 @@ string
 </tbody>
 </table>
 
-
 ## TenantsSpec { #tempo-grafana-com-v1alpha1-TenantsSpec }
 
 <p>
@@ -4145,7 +4089,6 @@ AuthorizationSpec
 </tbody>
 </table>
 
-
 ## TracingConfigSpec { #tempo-grafana-com-v1alpha1-TracingConfigSpec }
 
 <p>
@@ -4227,6 +4170,5 @@ string
 
 <hr/>
 
-
-
++newline
 
diff --git a/docs/operator/feature-gates.md b/docs/operator/feature-gates.md
index b3b171304..96afb11b6 100644
--- a/docs/operator/feature-gates.md
+++ b/docs/operator/feature-gates.md
@@ -1,17 +1,4 @@
-
----
-title: "Feature Gates"
-description: "Generated API docs for the Tempo Operator"
-lead: ""
-draft: false
-images: []
-menu:
-  docs:
-    parent: "operator"
-weight: 1000
-toc: true
----
-
+
 This Document contains the types introduced by the Tempo Operator to be consumed by users.
 
 > This page is automatically generated with `gen-crd-api-reference-docs`.