Documentation Build

Overview

The Datadog documentation contents live in many Github repository:

• Integrations-core
• Integrations-extras
• Internal Datadog repository

The idea behind it is to store content where it's created, and to display it where it's consumed.

On every documentation build (triggered by a Branch being merged to master) the script update_pre_build() is called. It pulls all content, transforms it, and puts it where it belong in the main documentation website.

Since #3749 the build strategy is defined in the file [pull_config.yaml] which has the following layout:

---
- org_name: <ORG_NAME>
  
  repos:
  - repo_name: <REPOSITORY_NAME>
    
    contents:

    - action: <ACTION_NAME>
      branch: <BRANCH_NAME>
      globs:
      - <GLOBS>
      options:
        <OPTIONS>

With the following variables:

Variable	Description
<ORG_NAME>	Github organisation name to pull content from.
<REPOSITORY_NAME>	Github repository name from <ORG_NAME> to pull content from.
<BRANCH_NAME>	Github branch name from <REPOSITORY_NAME> to pull content from.
<GLOBS>	Globs of files to pull from the <ORG_NAME>/<REPOSITORY_NAME>/<BRANCH_NAME> tree.
<ACTION_NAME>	Action to apply to the files pulled, refer to the Actions section to see the list of implemented actions.
<OPTIONS>	Depending of the <ACTION_NAME>, list of optional parameter.

Actions

integrations

source

pull-and-push-files

pull-and-push-folder