Documentation
ドキュメントの検索
karat

+

K

APIリファレンス ↗
5B. [Repositories] Publishing and Using Shared Libraries in Code Repositories15 - パイプラインにREADMEファイルを追加してドキュメント化する
Warning

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

15 - README ファイルでパイプラインを文書化する

この内容は learn.palantir.com ↗ でもご覧いただけますが、アクセシビリティの観点から、ここに掲載しています。

📖 タスクの概要

データフロー図を追加し、文書化の一環としています。次に、ユーザーの乗客リポジトリに README ファイルを追加し、さらなる詳細を記載します。

🔨 タスクの説明

  1. ユーザーの passengers_logic コードリポジトリを開きます。
  2. 新しいブランチ（Master から）を yourName/feature/add_readme という名前で作成します。
  3. リポジトリの左上、ブランチ名のすぐ下の ⊕ ボタンをクリックし、新規ファイル を選択します。
  4. 新規ファイル ウィンドウで、リポジトリファイル構造のルートに到達するまで左にスクロールします。次に、新しいファイルをルートフォルダーに作成したいことを示すために、/ をクリックします。以下のように表示されます。

  1. ファイル名を README.md とし、ウィンドウの右下にある青い 作成 ボタンをクリックします。

  2. 新しいファイルを開き、以下のブロックをエディタウィンドウに貼り付けます：

    ## 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. コードをコミットします（例： “feature: add readme”）。

  4. PR プロセスを完了し、ブランチを Master にマージします。マージを完了する前に、CI チェックがパスするのを待つ必要があります。