add a note about configgroup

pulumi · Aug 20, 2024 · 61c419c · 61c419c
1 parent dc7d560
commit 61c419c
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 20 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,5 +1,7 @@
-_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/)_
+{{% notes type="info" %}}
+A newer version is available as [kubernetes.helm.sh/v4.Chart](/registry/packages/kubernetes/api-docs/helm/v4/chart/).
+See the corresponding [blog post](/blog/kubernetes-yaml-v2/) for more information.
+{{% /notes %}}
 
 Chart is a component representing a collection of resources described by an arbitrary Helm Chart.
 

diff --git a/provider/pkg/gen/examples/overlays/configFile.md b/provider/pkg/gen/examples/overlays/configFile.md
@@ -1,7 +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/)_
+{{% notes type="info" %}}
+A newer version of this resource is available as [kubernetes.yaml/v2.ConfigFile](/registry/packages/kubernetes/api-docs/yaml/v2/configfile/#kubernetes-yaml-v2-configfile).
+See the corresponding [blog post](/blog/kubernetes-yaml-v2/) for more information.
+{{% /notes %}}
 
-ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+(If you have in-memory YAML a [ConfigGroup](../v2/configgroup) may be more appropriate.)
 
 This resource is provided for the following languages: Node.js (JavaScript, TypeScript), Python, Go, and .NET (C#, F#, VB).
 

diff --git a/provider/pkg/gen/examples/overlays/configFileV2.md b/provider/pkg/gen/examples/overlays/configFileV2.md
@@ -1,4 +1,5 @@
-ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+(If you have in-memory YAML a ConfigGroup may be more appropriate.)
 
 ## Dependency ordering
 Sometimes resources must be applied in a specific order. For example, a namespace resource must be

diff --git a/provider/pkg/gen/examples/overlays/configGroup.md b/provider/pkg/gen/examples/overlays/configGroup.md
@@ -1,5 +1,7 @@
-_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/)_
+{{% notes type="info" %}}
+A_newer version of this resource is available as [kubernetes.yaml/v2.ConfigGroup](/registry/packages/kubernetes/api-docs/yaml/v2/configgroup/).
+See the corresponding [blog post](/blog/kubernetes-yaml-v2/) for more information.
+{{% /notes %}}
 
 ConfigGroup creates a set of Kubernetes resources from Kubernetes YAML text. The YAML text
 may be supplied using any of the following methods:

diff --git a/provider/pkg/gen/examples/overlays/kustomizeDirectory.md b/provider/pkg/gen/examples/overlays/kustomizeDirectory.md
@@ -1,4 +1,6 @@
-_Note: a newer version is available: [kubernetes.kustomize/v2.Directory](/registry/packages/kubernetes/api-docs/kustomize/v2/directory/)_
+{{% notes type="info" %}}
+A newer version of this resource is available as [kubernetes.kustomize/v2.Directory](/registry/packages/kubernetes/api-docs/kustomize/v2/directory/).
+{{% /notes %}}
 
 Directory is a component representing a collection of resources described by a kustomize directory (kustomization).
 

diff --git a/sdk/dotnet/Yaml/V2/ConfigFile.cs b/sdk/dotnet/Yaml/V2/ConfigFile.cs
@@ -10,7 +10,8 @@
 namespace Pulumi.Kubernetes.Yaml.V2
 {
     /// <summary>
-    /// ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+    /// ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+    /// (If you have in-memory YAML a ConfigGroup may be more appropriate.)
     /// 
     /// ## Dependency ordering
     /// Sometimes resources must be applied in a specific order. For example, a namespace resource must be

diff --git a/sdk/go/kubernetes/yaml/v2/configFile.go b/sdk/go/kubernetes/yaml/v2/configFile.go
diff --git a/sdk/java/src/main/java/com/pulumi/kubernetes/yaml/v2/ConfigFile.java b/sdk/java/src/main/java/com/pulumi/kubernetes/yaml/v2/ConfigFile.java
@@ -15,7 +15,8 @@
 import javax.annotation.Nullable;
 
 /**
- * ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+ * ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+ * (If you have in-memory YAML a ConfigGroup may be more appropriate.)
  * 
  * ## Dependency ordering
  * Sometimes resources must be applied in a specific order. For example, a namespace resource must be

diff --git a/sdk/nodejs/yaml/v2/configFile.ts b/sdk/nodejs/yaml/v2/configFile.ts
@@ -5,7 +5,8 @@ import * as pulumi from "@pulumi/pulumi";
 import * as utilities from "../../utilities";
 
 /**
- * ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+ * ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+ * (If you have in-memory YAML a ConfigGroup may be more appropriate.)
  *
  * ## Dependency ordering
  * Sometimes resources must be applied in a specific order. For example, a namespace resource must be

diff --git a/sdk/python/pulumi_kubernetes/yaml/v2/ConfigFile.py b/sdk/python/pulumi_kubernetes/yaml/v2/ConfigFile.py
@@ -81,7 +81,8 @@ def __init__(__self__,
                  skip_await: Optional[pulumi.Input[bool]] = None,
                  __props__=None):
         """
-        ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+        ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+        (If you have in-memory YAML a ConfigGroup may be more appropriate.)
 
         ## Dependency ordering
         Sometimes resources must be applied in a specific order. For example, a namespace resource must be
@@ -143,7 +144,8 @@ def __init__(__self__,
                  args: ConfigFileArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+        ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+        (If you have in-memory YAML a ConfigGroup may be more appropriate.)
 
         ## Dependency ordering
         Sometimes resources must be applied in a specific order. For example, a namespace resource must be