From 3e76cb0199065bd5bb72f30e655f68084e2d2feb Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Tue, 15 Sep 2020 14:50:43 +0200 Subject: [PATCH] api-docs: add overwrites for external packages --- docs/api/helmrelease.md | 16 ++++++++++++---- hack/api-docs/config.json | 12 +++++++++++- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/api/helmrelease.md b/docs/api/helmrelease.md index 290e6a1..1d20d74 100644 --- a/docs/api/helmrelease.md +++ b/docs/api/helmrelease.md @@ -138,7 +138,9 @@ Defaults to the namespace of the HelmRelease.

dependsOn
-[]github.com/fluxcd/pkg/runtime/dependency.CrossNamespaceDependencyReference + +[]Runtime dependency.CrossNamespaceDependencyReference + @@ -264,7 +266,9 @@ and information about how they should be merged.

values
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes pkg/apis/apiextensions/v1.JSON + @@ -724,7 +728,9 @@ Defaults to the namespace of the HelmRelease.

dependsOn
-[]github.com/fluxcd/pkg/runtime/dependency.CrossNamespaceDependencyReference + +[]Runtime dependency.CrossNamespaceDependencyReference + @@ -850,7 +856,9 @@ and information about how they should be merged.

values
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes pkg/apis/apiextensions/v1.JSON + diff --git a/hack/api-docs/config.json b/hack/api-docs/config.json index 87c291a..5ac7319 100644 --- a/hack/api-docs/config.json +++ b/hack/api-docs/config.json @@ -11,14 +11,24 @@ "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" }, + { + "typeMatchPrefix": "^k8s\\.io/apiextensions-apiserver/pkg/apis/apiextensions/v1\\.JSON$", + "docsURLTemplate": "https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON" + }, { "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + }, + { + "typeMatchPrefix": "^github.com/fluxcd/pkg/runtime/dependency\\.CrossNamespaceDependencyReference$", + "docsURLTemplate": "https://godoc.org/github.com/fluxcd/pkg/runtime/dependency#CrossNamespaceDependencyReference" } ], "typeDisplayNamePrefixOverrides": { "k8s.io/api/": "Kubernetes ", - "k8s.io/apimachinery/pkg/apis/": "Kubernetes " + "k8s.io/apimachinery/pkg/apis/": "Kubernetes ", + "k8s.io/apiextensions-apiserver/": "Kubernetes ", + "github.com/fluxcd/pkg/runtime/": "Runtime " }, "markdownDisabled": false }