Skip to content

How to display an Integration in documentation integrations page?

Jump to bottom
David Jones edited this page May 10, 2021 · 8 revisions

Overview

Most of the Datadog integrations are automatically pulled from:

Note: Integrations are pulled only from the Master branch.

To know in which repository the integration is stored, scroll down to the bottom of the integration page to find a direct link to the source file:

If you don't see this it means that the integration is stored in the Datadog internal repo.

Files used for building an integration

For each integration, we use the following files to generate the documentation page:

  • Readme.md
  • metadata.csv
  • manifest.json

The Readme.md is used to generate the main content, metadata.csv is used to generate the metrics table in the Data Collected section and manifest.json is used as supporting page data to determine page visibility and crawler type.

Display an integration in /integrations

In order to display an integration in /integrations you need to :

  1. Push your integrations in one of the source repositories: integrations-core or integrations-extras by following the new integrations creation rules.

  2. Add you integrations logo in documentation repository in the /static/images/integrations_logos/ You no longer have to place a logo in the repository. Instead the logo will be sourced automaticall from druids by matching the integration_id used in the manifest.json to the name used in druids.

NOTE If you want to see the integrations from integrations-core/extras on your local development environment, you will need to make sure you have a Makefile.config setup and that FETCH_INTEGRATIONS is set to true and that you have a GITHUB_TOKEN populated (Learn how to create your Github personal token).

Inline metrics table

To display the metric table in the ### Metrics sub-section you need to have the following sentences in your Readme.md file:

  • See metadata.csv for a list of metrics provided by this integration.
  • See metadata.csv for a list of metrics provided by this check.

On build, this sentence is removed and replaced by the following partial groups:

{{< get-metrics-from-git "INTEGRATION_NAME" >}}

That allows metrics inlining.

Don't forget to read our contributing guidelines!

Clone this wiki locally