3. [Builder] Creating a Project Output8. Documenting Your Pipeline With Notepad

8 - Documenting your Pipeline with Notepad

This content is also available at learn.palantir.com ↗ and is presented here for accessibility purposes.

📖 Task Introduction

A Data Lineage graph visually depicts pipeline segments for your team, but there are additional details you’ll want to document about your pipeline scope such as:

  • Service level agreements
  • Points of contact
  • Data expectations
  • Usage parameters
  • Troubleshooting steps
  • Non-standard features

In this task, you’ll use Notepad — Foundry’s versatile rich text editor — to add more information about your pipeline in the Datasource project’s /documentation folder.

🔨 Task Instructions

  1. Open your Datasource project’s /documentation folder.

  2. Click the green ➕ New ▾ button in the upper right of the screen and choose Document.

  3. Click into the generic filename in the top left and rename it to Flight Alerts Datasource Project Pipeline Documentation.

  4. Add the following text to the document and use the options in the upper-left of the application screen to adjust heading and sub-heading sizes, add bullets and numbering, and add any other discretionary styling desired:

    **Flight Alerts Pipeline**
    **Ownership**
    
    * Project team: Aviation Data Development
    * Project owner: [yourName@yourOrganization.com](mailto:yourName@yourOrganization.com)
    
    **Overview**
    This pipeline takes raw data ingested from the Flight Alerts datasource and:
    
    1. Normalizes column names and data types across all raw datasets
    2. Maps status codes from numbers to strings that represent their human meanings
    3. Adds two null string columns (one for assignee, and one for comment) to be used in operational downstream workflows