From 60b3c9a8f063ec326bc728954eebaddef50e4f9f Mon Sep 17 00:00:00 2001
From: Colleen McGinnis <colleen.mcginnis@elastic.co>
Date: Tue, 30 Aug 2022 17:34:55 -0500
Subject: [PATCH 1/3] add template language to packageDocsReadme

---
 .../packages/archetype/package_docs_readme.go | 85 ++++++++++++++++++-
 1 file changed, 82 insertions(+), 3 deletions(-)

diff --git a/internal/packages/archetype/package_docs_readme.go b/internal/packages/archetype/package_docs_readme.go
index d697b7fdc0..be899a989a 100644
--- a/internal/packages/archetype/package_docs_readme.go
+++ b/internal/packages/archetype/package_docs_readme.go
@@ -4,8 +4,87 @@
 
 package archetype
 
-const packageDocsReadme = `# {{.Manifest.Title}}
+const packageDocsReadme = `<!-- Use this template language as a starting point, replacing {placeholder text} with details about the integration. -->
+<!-- Find more detailed documentation guidelines in https://github.com/elastic/integrations/blob/main/docs/documentation_guidelines.md -->
 
-This is a new integration created using the [elastic-package](https://github.com/elastic/elastic-package) tool.
+# {{.Manifest.Title}}
 
-Consider using the README template file ` + "`_dev/build/docs/README.md`" + `to generate a list of exported fields or include a sample event.`
+<!-- The {{.Manifest.Title}} integration allows you to monitor {name of service}. {name of service} is {describe service}.
+
+Use the {{.Manifest.Title}} integration to {purpose}. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference {data stream type} when troubleshooting an issue.
+
+For example, if you wanted to {sample use case} you could {action}. Then you can {visualize|alert|troubleshoot} by {action}. -->
+
+## Data streams
+
+<!-- The {{.Manifest.Title}} integration collects {one|two} type{s} of data streams: {logs and/or metrics}. -->
+
+<!-- If applicable -->
+<!-- **Logs** help you keep a record of events happening in {service}.
+Log data streams collected by the {name} integration include {sample data stream(s)} and more. See more details in the [Logs](#logs-reference). -->
+
+<!-- If applicable -->
+<!-- **Metrics** give you insight into the state of {service}.
+Metric data streams collected by the {name} integration include {sample data stream(s)} and more. See more details in the [Metrics](#metrics-reference). -->
+
+<!-- Optional: Any additional notes on data streams -->
+
+## Requirements
+
+You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
+You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
+
+<!--
+	Optional: Other requirements including:
+	* System compatibility
+	* Supported versions of third-party products
+	* Permissions needed
+	* Anything else that could block a user from successfully using the integration
+-->
+
+## Setup
+
+<!-- Any prerequisite instructions -->
+
+For step-by-step instructions on how to set up an integration, see the
+[Getting started](https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html) guide.
+
+<!-- Additional set up instructions -->
+
+<!-- If applicable -->
+<!-- ## Logs reference -->
+
+<!-- Repeat for each data stream of the current type -->
+<!-- ### {Data stream name}
+
+The ` + "`{data stream name}`" + ` data stream provides events from {source} of the following types: {list types}. -->
+
+<!-- Optional -->
+<!-- #### Example
+
+An example event for ` + "`{data stream name}`" + ` looks as following:
+
+{code block with example} -->
+
+<!-- #### Exported fields
+
+{insert table} -->
+
+<!-- If applicable -->
+<!-- ## Metrics reference -->
+
+<!-- Repeat for each data stream of the current type -->
+<!-- ### {Data stream name}
+
+The ` + "`{data stream name}`" + ` data stream provides events from {source} of the following types: {list types}. -->
+
+<!-- Optional -->
+<!-- #### Example
+
+An example event for ` + "`{data stream name}`" + ` looks as following:
+
+{code block with example} -->
+
+<!-- #### Exported fields
+
+{insert table} -->`

From b64e0e7ef9bb9098e6ec567f830106f728454220 Mon Sep 17 00:00:00 2001
From: Colleen McGinnis <colleen.mcginnis@elastic.co>
Date: Tue, 6 Sep 2022 14:02:09 -0500
Subject: [PATCH 2/3] add helpers to generate example events and field tables

---
 internal/packages/archetype/package_docs_readme.go | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/internal/packages/archetype/package_docs_readme.go b/internal/packages/archetype/package_docs_readme.go
index be899a989a..93189b9f68 100644
--- a/internal/packages/archetype/package_docs_readme.go
+++ b/internal/packages/archetype/package_docs_readme.go
@@ -64,11 +64,11 @@ The ` + "`{data stream name}`" + ` data stream provides events from {source} of
 
 An example event for ` + "`{data stream name}`" + ` looks as following:
 
-{code block with example} -->
+{{event "{data stream}"}} -->
 
 <!-- #### Exported fields
 
-{insert table} -->
+{{fields "{data stream}"}} -->
 
 <!-- If applicable -->
 <!-- ## Metrics reference -->
@@ -83,8 +83,8 @@ The ` + "`{data stream name}`" + ` data stream provides events from {source} of
 
 An example event for ` + "`{data stream name}`" + ` looks as following:
 
-{code block with example} -->
+{{event "{data stream}"}} -->
 
 <!-- #### Exported fields
 
-{insert table} -->`
+{{fields "{data stream}"}} -->`

From 60a3ebac2407e4208e9417b46b3cfa6c7548ab2e Mon Sep 17 00:00:00 2001
From: Colleen McGinnis <colleen.mcginnis@elastic.co>
Date: Thu, 8 Sep 2022 16:59:51 -0500
Subject: [PATCH 3/3] Revert "add helpers to generate example events and field
 tables"

This reverts commit b64e0e7ef9bb9098e6ec567f830106f728454220.
---
 internal/packages/archetype/package_docs_readme.go | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/internal/packages/archetype/package_docs_readme.go b/internal/packages/archetype/package_docs_readme.go
index 93189b9f68..be899a989a 100644
--- a/internal/packages/archetype/package_docs_readme.go
+++ b/internal/packages/archetype/package_docs_readme.go
@@ -64,11 +64,11 @@ The ` + "`{data stream name}`" + ` data stream provides events from {source} of
 
 An example event for ` + "`{data stream name}`" + ` looks as following:
 
-{{event "{data stream}"}} -->
+{code block with example} -->
 
 <!-- #### Exported fields
 
-{{fields "{data stream}"}} -->
+{insert table} -->
 
 <!-- If applicable -->
 <!-- ## Metrics reference -->
@@ -83,8 +83,8 @@ The ` + "`{data stream name}`" + ` data stream provides events from {source} of
 
 An example event for ` + "`{data stream name}`" + ` looks as following:
 
-{{event "{data stream}"}} -->
+{code block with example} -->
 
 <!-- #### Exported fields
 
-{{fields "{data stream}"}} -->`
+{insert table} -->`