Add autogen warning to index file (#2493)

This pull request adds a Markdown comment containing an autogen warning
to the _index.md file.

It does so immediately inside the Hugo frontmatter. h/t to @iwahbe for
pointing out Markdown will work fine here.

Fixes #2485.

Author: guineveresaenger

pkg/tfgen/installation_docs.go

@@ -82,8 +82,9 @@ func writeFrontMatter(providerName string) string {
 	// Capitalize the package name
 	capitalize := cases.Title(language.English)
 	title := capitalize.String(providerName)
-
 	return fmt.Sprintf(delimiter+
+		"# *** WARNING: This file was auto-generated. "+
+		"Do not edit by hand unless you're certain you know what you are doing! ***\n"+
 		"title: %[1]s Provider\n"+
 		"meta_desc: Provides an overview on how to configure the Pulumi %[1]s provider.\n"+
 		"layout: package\n"+

pkg/tfgen/installation_docs_test.go

@@ -272,6 +272,8 @@ func TestWriteFrontMatter(t *testing.T) {
 		name:         "Generates Front Matter for installation-configuration.md",
 		providerName: "test",
 		expected: delimiter +
+			"# *** WARNING: This file was auto-generated. " +
+			"Do not edit by hand unless you're certain you know what you are doing! ***\n" +
 			"title: Test Provider\n" +
 			"meta_desc: Provides an overview on how to configure the Pulumi Test provider.\n" +
 			"layout: package\n" +

pkg/tfgen/test_data/convert-index-file-edit-rules/expected.md

@@ -1,4 +1,5 @@
 ---
+# *** WARNING: This file was auto-generated. Do not edit by hand unless you're certain you know what you are doing! ***
 title: Libvirt Provider
 meta_desc: Provides an overview on how to configure the Pulumi Libvirt provider.
 layout: package

pkg/tfgen/test_data/convert-index-file/expected.md

@@ -1,4 +1,5 @@
 ---
+# *** WARNING: This file was auto-generated. Do not edit by hand unless you're certain you know what you are doing! ***
 title: Libvirt Provider
 meta_desc: Provides an overview on how to configure the Pulumi Libvirt provider.
 layout: package