diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/create.py b/datadog_checks_dev/datadog_checks/dev/tooling/create.py index fd0df7948e086..be3f7fb2e3ac3 100644 --- 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/datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/marketplace/README.md b/datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/marketplace/README.md index d1e2a21f4a284..7fdb4d4a91732 100644 --- a/datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/marketplace/README.md +++ b/datadog_checks_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/datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md b/datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/tile_v2/README.md new file mode 100644 index 0000000000000..9d89a32f5e1df --- /dev/null +++ b/datadog_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/