From 37cdcdf111d0eea84db9ade7fab7a9b8bf7715c2 Mon Sep 17 00:00:00 2001 From: Yota Hamada Date: Wed, 3 Sep 2025 00:08:46 +0900 Subject: [PATCH] doc: remove deprecated field name in the doc --- docs/features/executors/shell.md | 2 +- docs/reference/yaml.md | 4 ---- docs/writing-workflows/basics.md | 4 ++-- docs/writing-workflows/data-variables.md | 2 +- docs/writing-workflows/examples.md | 4 ++-- 5 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/features/executors/shell.md b/docs/features/executors/shell.md index c72c1317..5d2db86d 100644 --- a/docs/features/executors/shell.md +++ b/docs/features/executors/shell.md @@ -153,7 +153,7 @@ steps: # Working directory - name: in-directory - dir: /app/src + workingDir: /app/src command: npm install ``` diff --git a/docs/reference/yaml.md b/docs/reference/yaml.md index 33115bbc..0b083a2f 100644 --- a/docs/reference/yaml.md +++ b/docs/reference/yaml.md @@ -223,10 +223,6 @@ steps: - name: custom-dir workingDir: /custom # Override DAG workingDir command: pwd # Outputs: /custom - - - name: also-custom - dir: /another # Alternative to workingDir - command: pwd # Outputs: /another ``` ### Queue Configuration diff --git a/docs/writing-workflows/basics.md b/docs/writing-workflows/basics.md index 83cf7a07..145372ee 100644 --- a/docs/writing-workflows/basics.md +++ b/docs/writing-workflows/basics.md @@ -251,11 +251,11 @@ Set where commands execute: ```yaml steps: - name: in-project - dir: /home/user/project + workingDir: /home/user/project command: python main.py - name: in-data - dir: /data/input + workingDir: /data/input command: ls -la ``` diff --git a/docs/writing-workflows/data-variables.md b/docs/writing-workflows/data-variables.md index 643c50d5..742ca25f 100644 --- a/docs/writing-workflows/data-variables.md +++ b/docs/writing-workflows/data-variables.md @@ -14,7 +14,7 @@ env: - SOME_FILE: ${SOME_DIR}/some_file steps: - name: task - dir: ${SOME_DIR} + workingDir: ${SOME_DIR} command: python main.py ${SOME_FILE} ``` diff --git a/docs/writing-workflows/examples.md b/docs/writing-workflows/examples.md index 769504b5..0743961e 100644 --- a/docs/writing-workflows/examples.md +++ b/docs/writing-workflows/examples.md @@ -582,7 +582,7 @@ env: - API_KEY: ${SECRET_API_KEY} steps: - name: task - dir: ${SOME_DIR} + workingDir: ${SOME_DIR} command: python main.py ${SOME_FILE} ``` @@ -858,7 +858,7 @@ Run multi-line scripts. ```yaml steps: - name: step in specific directory - dir: /path/to/working/directory + workingDir: /path/to/working/directory command: pwd && ls -la ```