Add new README for Tile-only integrations (#11712)

* Add new README for Tile-only integrations * Fix tests * Update datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md Co-authored-by: Austin Lai <76412946+alai97@users.noreply.github.com> * Update datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md Co-authored-by: Austin Lai <76412946+alai97@users.noreply.github.com> * Update README.md Sorry, accidentally committed suggested changes. Removing further reading section so that we can add this section to all templates across the board at a higher level. * Update datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md Co-authored-by: Austin Lai <76412946+alai97@users.noreply.github.com> Co-authored-by: Ana Wishnoff <ana.wishnoff@datadoghq.com>
DataDog · Mar 28, 2022 · d4db50a · d4db50a
1 parent 9d3a247
commit d4db50a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 6 deletions.
diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/create.py b/datadog_checks_dev/datadog_checks/dev/tooling/create.py
@@ -129,10 +129,16 @@ def create_template_files(template_name, new_root, config, read=False):
     for root, _, template_files in os.walk(template_root):
         for template_file in template_files:
             if not template_file.endswith(('.pyc', '.pyo')):
-                # Use a special README for the marketplace/partner support_type integrations
-                if template_file == 'README.md' and config.get('support_type') == 'partner':
-                    template_path = path_join(TEMPLATES_DIR, 'marketplace/', 'README.md')
-                    file_path = path_join("/", config.get('check_name'), "README.md")
+                if template_file == 'README.md' and config.get('support_type') in ('partner', 'contrib'):
+                    # Custom README for the marketplace/partner support_type integrations
+                    if config.get('support_type') == 'partner':
+                        template_path = path_join(TEMPLATES_DIR, 'marketplace/', 'README.md')
+                        file_path = path_join("/", config.get('check_name'), "README.md")
+
+                    # Custom README for tile apps
+                    elif config.get('support_type') == 'contrib' and config.get('manifest_v2'):
+                        template_path = path_join(TEMPLATES_DIR, 'tile_v2/', 'README.md')
+                        file_path = path_join("/", config.get('check_name'), "README.md")
 
                 # Use a special readme file for media carousel information
                 # .gitkeep currently only used for images, but double check anyway

diff --git a/...ecks_dev/datadog_checks/dev/tooling/templates/integration/marketplace/README.md b/...ecks_dev/datadog_checks/dev/tooling/templates/integration/marketplace/README.md
@@ -1,8 +1,9 @@
 # {integration_name}
 
 ## Overview
-High level overview of what this integration does
-Usually includes a screenshot
+High level overview of what this integration does.
+
+Screenshots should be absent for this section, instead put them in the media carousel with captions.
 
 All `###` headers are optional to showcase what this integration includes
 
@@ -17,5 +18,7 @@ All `###` headers are optional to showcase what this integration includes
 ## Setup
 Specific step-by-step configuration instructions for this integration.
 
+Screenshots are okay for this section, if they help demonstrate configuration steps.
+
 ## Support
 Information about how and where to go for support for this integration
diff --git a/...g_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md b/...g_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md
@@ -0,0 +1,30 @@
+# {integration_name}
+
+## Overview
+
+< Provide some background information on your software, along with specifics about what is being offered in your Datadog app >
+
+## Setup
+
+### Installation
+
+1. Click the **Add Widgets** button on a Datadog dashboard.
+2. Select **Apps** from the widget menu.
+3. Drag and drop the {integration_name} widget on your dashboard.
+
+### Configuration
+
+< Add any extra configuration steps for your app, including any options or settings that the user has to configure before the app is able to function >
+
+### Validation
+
+< Steps to validate that the app is functioning as expected. If no validation steps are needed, delete this section >
+
+## Support
+
+< Add any links to relevant documentation regarding your Datadog app >
+
+Need help? Contact [Datadog support][1].
+
+
+[1]: https://docs.datadoghq.com/help/