5B. [Repositories] Publishing and Using Shared Libraries in Code Repositories15. Document Your Pipeline With A Readme File

15 - Document Your Pipeline with a README File

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

📖 Task Introduction

You’ve added a Data Lineage graph as a measure of documentation. You’ll now add a README file in your passengers repository with additional details.

🔨 Task Instructions

  1. Open your passengers_logic code repository.
  2. Create a new branch (from Master) named yourName/feature/add_readme.
  3. Click the button just underneath the branch name in the top left of your repository and choose New file.
  4. In the New file window, scroll all the way to the left until you reach the root of the repository file structure. Then, click the / to indicate you want to create a new file in the root folder as shown below.

  1. Name your file README.md and click the blue Create button in the bottom right of the window.

  2. Open your new file and paste the following block into the editor window:

    ## Passengers Pipeline
    #### Ownership
    * Project team: Aviation Data Development   
    * Project owner: yourName@yourOrganization.com   
    
    #### Overview
    This pipeline takes raw data ingested from the Passengers datasource and:   
    1. Parses raw CSVs and JSONs into dataframes   
    2. Normalizes column names and data types across all raw datasets   
    
  3. Commit your code (e.g., “feature: add readme”).

  4. Complete the PR process to merge the branch into Master. You will need to wait for CI checks to pass before completing the merge.