Doc updates for overlay resources (#3064)

### Proposed changes  Some minor updates to the API docs for the overlay components: - link to the newer version of the respective component, since the newer versions have fixes for some of the long-standing issues with these overlays. - clarify the supported languages I had considered adding a "known issues" section, e.g. to mention the `dependsOn` limitation, but I felt it would be overkill, and that simply linking to the newer version would suffice. ### Related issues (optional)  Closes #1773 Closes #2181
pulumi · Jun 17, 2024 · a8ca738 · a8ca738
1 parent dc1febf
commit a8ca738
Show file tree

Hide file tree

Showing 18 changed files with 47 additions and 14 deletions.
diff --git a/provider/cmd/pulumi-resource-kubernetes/schema.json b/provider/cmd/pulumi-resource-kubernetes/schema.json
diff --git a/provider/pkg/gen/examples/overlays/chartV3.md b/provider/pkg/gen/examples/overlays/chartV3.md
@@ -1,3 +1,6 @@
+_Note: a newer version is available: [kubernetes.helm.sh/v4.Chart](/registry/packages/kubernetes/api-docs/helm/v4/chart/)_
+_See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+
 Chart is a component representing a collection of resources described by an arbitrary Helm Chart.
 
 The Helm Chart can be fetched from any source that is accessible to the `helm` command line. Values in the `values.yml` file can be overridden using `ChartOpts.values` (equivalent to `--set` or having multiple `values.yml` files). Objects can be transformed arbitrarily by supplying callbacks to `ChartOpts.transformations`.
@@ -8,6 +11,8 @@ The `Chart` resource renders the templates from your chart and then manage them
 
 You may also want to consider the `Release` resource as an alternative method for managing helm charts. For more information about the trade-offs between these options see: [Choosing the right Helm resource for your use case](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/choosing-the-right-helm-resource-for-your-use-case)
 
+This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
+
 {{% examples %}}
 ## Example Usage
 {{% example %}}

diff --git a/provider/pkg/gen/examples/overlays/chartV4.md b/provider/pkg/gen/examples/overlays/chartV4.md
@@ -1,3 +1,5 @@
+_See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+
 Chart is a component representing a collection of resources described by a Helm Chart.
 Helm charts are a popular packaging format for Kubernetes applications, and published
 to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1). 

diff --git a/provider/pkg/gen/examples/overlays/configFile.md b/provider/pkg/gen/examples/overlays/configFile.md
@@ -1,5 +1,10 @@
+_Note: a newer version is available: [kubernetes.yaml/v2.ConfigFile](/registry/packages/kubernetes/api-docs/yaml/v2/configfile/#kubernetes-yaml-v2-configfile)_
+_See also: [New: ConfigGroup, ConfigFile resources for Java, YAML SDKs](/blog/kubernetes-yaml-v2/)_
+
 ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
 
+This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
+
 {{% examples %}}
 ## Example Usage
 {{% example %}}

diff --git a/provider/pkg/gen/examples/overlays/configGroup.md b/provider/pkg/gen/examples/overlays/configGroup.md
@@ -1,3 +1,6 @@
+_Note: a newer version is available: [kubernetes.yaml/v2.ConfigGroup](/registry/packages/kubernetes/api-docs/yaml/v2/configgroup/)_
+_See also: [New: ConfigGroup, ConfigFile resources for Java, YAML SDKs](/blog/kubernetes-yaml-v2/)_
+
 ConfigGroup creates a set of Kubernetes resources from Kubernetes YAML text. The YAML text
 may be supplied using any of the following methods:
 
@@ -6,6 +9,8 @@ may be supplied using any of the following methods:
 3. Using a literal string containing YAML, or a list of such strings:
 4. Any combination of files, patterns, or YAML strings:
 
+This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
+
 {{% examples %}}
 ## Example Usage
 {{% example %}}

diff --git a/provider/pkg/gen/examples/overlays/kustomizeDirectory.md b/provider/pkg/gen/examples/overlays/kustomizeDirectory.md
@@ -1,5 +1,9 @@
+_Note: a newer version is available: [kubernetes.kustomize/v2.Directory](/registry/packages/kubernetes/api-docs/kustomize/v2/directory/)_
+
 Directory is a component representing a collection of resources described by a kustomize directory (kustomization).
 
+This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
+
 {{% examples %}}
 ## Example Usage
 {{% example %}}

diff --git a/sdk/dotnet/Helm/V4/Chart.cs b/sdk/dotnet/Helm/V4/Chart.cs
@@ -10,6 +10,8 @@
 namespace Pulumi.Kubernetes.Helm.V4
 {
     /// <summary>
+    /// _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+    /// 
     /// Chart is a component representing a collection of resources described by a Helm Chart.
     /// Helm charts are a popular packaging format for Kubernetes applications, and published
     /// to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&amp;sort=relevance&amp;page=1).

diff --git a/sdk/dotnet/Pulumi.Kubernetes.csproj b/sdk/dotnet/Pulumi.Kubernetes.csproj
@@ -9,7 +9,7 @@
     <PackageProjectUrl>https://pulumi.com</PackageProjectUrl>
     <RepositoryUrl>https://github.com/pulumi/pulumi-kubernetes</RepositoryUrl>
     <PackageIcon>logo.png</PackageIcon>
-    <Version>4.14.0-alpha.1717706484+a162c42</Version>
+    <Version>4.0.0-alpha.0+dev</Version>
 
     <TargetFramework>net6.0</TargetFramework>
     <Nullable>enable</Nullable>

diff --git a/sdk/dotnet/pulumi-plugin.json b/sdk/dotnet/pulumi-plugin.json
@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "kubernetes",
-  "version": "4.14.0-alpha.1717706484+a162c42"
+  "version": "4.0.0-alpha.0+dev"
 }
diff --git a/sdk/go/kubernetes/helm/v4/chart.go b/sdk/go/kubernetes/helm/v4/chart.go
diff --git a/sdk/go/kubernetes/pulumi-plugin.json b/sdk/go/kubernetes/pulumi-plugin.json
@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "kubernetes",
-  "version": "4.14.0-alpha.1717706484+a162c42"
+  "version": "4.0.0-alpha.0+dev"
 }
diff --git a/sdk/go/kubernetes/utilities/pulumiUtilities.go b/sdk/go/kubernetes/utilities/pulumiUtilities.go
diff --git a/sdk/java/src/main/java/com/pulumi/kubernetes/helm/v4/Chart.java b/sdk/java/src/main/java/com/pulumi/kubernetes/helm/v4/Chart.java
@@ -15,6 +15,8 @@
 import javax.annotation.Nullable;
 
 /**
+ * _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+ * 
  * Chart is a component representing a collection of resources described by a Helm Chart.
  * Helm charts are a popular packaging format for Kubernetes applications, and published
  * to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&amp;sort=relevance&amp;page=1).

diff --git a/sdk/nodejs/helm/v4/chart.ts b/sdk/nodejs/helm/v4/chart.ts
@@ -8,6 +8,8 @@ import * as enums from "../../types/enums";
 import * as utilities from "../../utilities";
 
 /**
+ * _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+ *
  * Chart is a component representing a collection of resources described by a Helm Chart.
  * Helm charts are a popular packaging format for Kubernetes applications, and published
  * to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1).

diff --git a/sdk/nodejs/package.json b/sdk/nodejs/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@pulumi/kubernetes",
-    "version": "4.14.0-alpha.1717706484+a162c42",
+    "version": "4.0.0-alpha.0+dev",
     "keywords": [
         "pulumi",
         "kubernetes",
@@ -32,6 +32,6 @@
     "pulumi": {
         "resource": true,
         "name": "kubernetes",
-        "version": "4.14.0-alpha.1717706484+a162c42"
+        "version": "4.0.0-alpha.0+dev"
     }
 }
diff --git a/sdk/python/pulumi_kubernetes/helm/v4/Chart.py b/sdk/python/pulumi_kubernetes/helm/v4/Chart.py
@@ -281,6 +281,8 @@ def __init__(__self__,
                  version: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
+        _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+
         Chart is a component representing a collection of resources described by a Helm Chart.
         Helm charts are a popular packaging format for Kubernetes applications, and published
         to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1).
@@ -468,6 +470,8 @@ def __init__(__self__,
                  args: ChartArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
+
         Chart is a component representing a collection of resources described by a Helm Chart.
         Helm charts are a popular packaging format for Kubernetes applications, and published
         to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1).

diff --git a/sdk/python/pulumi_kubernetes/pulumi-plugin.json b/sdk/python/pulumi_kubernetes/pulumi-plugin.json
@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "kubernetes",
-  "version": "4.14.0-alpha.1717706484+a162c42"
+  "version": "4.0.0-alpha.0+dev"
 }
diff --git a/sdk/python/pyproject.toml b/sdk/python/pyproject.toml
@@ -5,7 +5,7 @@
   keywords = ["pulumi", "kubernetes", "category/cloud", "kind/native"]
   readme = "README.md"
   requires-python = ">=3.8"
-  version = "4.14.0a1717706484+a162c42"
+  version = "4.0.0a0+dev"
   [project.license]
     text = "Apache-2.0"
   [project.urls]