Англійська мова для розробників Windmill Workflow

Обговорення Windmill запозичують терміни з оркестрації робочого потоку, але застосовують їх до легшого, скриптового інструмента, тому розробник, який звик до важчих платформ, таких як Airflow, повинен перекалібрувати, що означають слова «потоку» і «крок» в цьому контексті.

Ключовий словник

** Потік ** — робочий потік Windmill, що складається з упорядкованих кроків, кожен з яких може бути скриптом, іншим потоком або умовою розгалуження, визначеним візуально або у вигляді YAML.

• “Запакувати скрипт поглинання і скрипт сповіщення у єдиний потік, щоб повторні спроби застосовувалися до всієї послідовності, а не лише до одного кроку.” *

** Скрипт як будівельний блок ** — модель Windmill, за якої будь- який скрипт у підтримуваній мові стає повторюваним, незалежно викликаним блоком, потоки якого можна з’ єднати. “Не дублюйте логіку сповіщення Slack — це вже скрипт; просто введіть посилання на нього як на блок у новому потоці.”

** Крок затвердження ** — крок потоку, який призупиняє виконання і чекає на затвердження або відхилення людиною перед продовженням, часто використовується для будь- чого, що стосується виробничих даних.

• “Додати крок затвердження перед дією delete- records — ніхто не повинен мати змогу виконати цю дію без нагляду.” *

** Ресурс ** — збережені, повторювальні налаштування з’ єднання (учасницькі дані бази даних, токени API), які скрипти і потоки посилаються за назвою замість твердих секретів. “Застосовувати в скрипту посилання на ресурс prod-db замість вставлення рядка з’ єднання — його обертають центрально і перевіряють.”

** Програма Windmill ** — легкий внутрішній інтерфейс користувача, побудований з компонентів Windmill, який запускає скрипти або потоки і показує їх вивід без окремого розгортання інтерфейсу. “Нам не потрібен цілий внутрішній інструмент для цього — програма Windmill з формою і кнопкою покриває весь запит.”

Звичайні фрази

• Чи слід це бути одним потоком з кроком схвалення, або двома окремими потоками з ручним передачі?»
• Чи є цей сценарій вже будівельним блоком десь, чи ми дублюємо логіку?»
• «З якого ресурсу цей скрипт витягує дані про підписку, і хто має доступ до його обертання?»
• Чи потрібно нам повне застосування для цього, або достатньо запланованого потоку?»
• «Звідки цей потік повторює спробу, якщо крок три зазнає невдачі — весь потік, або тільки цей крок?»

Приклади висловлювань

Зневадження невдалого запуску:

• « Потік зазнав невдачі на кроці схвалення, оскільки термін дії токена ресурсу закінчився — сам скрипт навіть не був запущений. » *

Пояснення вибору архітектури:

• “Ми створили цей поток як поток Windmill замість завдання cron на сервері, оскільки ми отримуємо повторні спроби, крок схвалення і історію запуску безкоштовно.” *

Перегляд запиту на звантаження: “Витягнути це у власний скрипт — це корисно поза цим потоком, і розглядання цього як окремого блоку означає, що ми можемо перевірити це в ізоляції.”

Професійні поради

• Кажіть ** поток **, а не “конвейер” або “робочий потік”, коли обговорюєте Windmill конкретно - це відображає безпосередньо концепцію в інтерфейсі користувача і API інструменту.
• Викликати ** ресурси ** за назвою у переглядах, щоб зробити походження уповноважених даних явним, а не припускати, що переглядачі знають, звідки походить токен.
• Рекомендуємо ** крок схвалення ** проактивно для будь- чого деструктивного — це сигналізує, що ви думаєте про безпеку виробництва, а не тільки швидкість автоматизації.
• Відрізняти Windmill від « інтерфейсу » — це специфічна легка конструкція, а не загальна веб- програма.

Практичні вправи

1. Поясніть, коли і чому додавати крок схвалення до потоку.
2. Описати, що таке « ресурс » у Windmill і чому скрипти не повинні твердо кодувати унікальні дані користувача.
3. Напишіть речення, яке обґрунтовує створення програми Windmill замість самостійного внутрішнього інструменту для простого процесу затвердження запитів.

Національний склад населення: Перепис населення та проживання

Будьмо чесними - навіть з чітким розумінням самої термінології Windmill (потоки, скрипти, схвалення тощо), спілкування залишається значною перешкодою для багатьох розробників, які вивчають професійну англійську. Це не просто про те, щоб знати, що таке «тригер»; це про те, щоб чітко і ефективно сформулювати свої думки в спільному середовищі розробки. Часто нерозуміння виникають просто через тонкі відмінності у фразування або спосіб, в який представлено зворотній зв’язок. Наприклад, отримання коментаря на кшталт «Цей потік потребує більшої надійності» не є негайно дієздатним. Що насправді означає «надійність»? Це може означати збільшення обробки помилок, кращу перевірку вводу або навіть більш стійкий дизайн для обробки неочікуваних умов - всі з яких потребують пояснення. Аналогічно, запропоновані зміни до опису Запиту на завантаження потребують ретельного розгляду. Просто сказати «виправити цю помилку» недостатньо. Вам слід пояснити контекст, * чому * це помилка, і, ідеально, запропонувати рішення або запропонувати області для подальшого дослідження.

Іншим поширеним викликом є розуміння рівня деталей, очікуваних при обговоренні технічних питань. Рідні носії англійської часто природно надають більше контексту, ніж вони можуть усвідомити, припускаючи певну базу спільних знань. Нерідні носії можуть відчувати себе змушеними перебільшувати пояснення, що призводить до довгих дискусій, які не обов’язково рухаються вперед. Важливо досягти балансу — достатньо інформації для ясності, але не так багато, щоб перевантажити слухача. Вивчення фраз, таких як «Щоб пояснити…» або «Чи можете ви розглянути…», демонструє залученість і дозволяє вам ніжно направляти розмову назад до основної проблеми, не з’являючись відверто. Крім того, активне слухання і перефразування того, що ви чули («Тоді, якщо я правильно розумію, ви пропонуєте…») є неоціненним для забезпечення взаєморозуміння. Не бійтеся запитати про конкретні приклади або подальші пояснення; набагато краще шукати пояснення, ніж продовжувати з неправильним тлумаченням.

Розгляньте це повідомлення Slack від старшого розробника, який переглядає PR: «Гей @john.doe, я бачу деякі потенційні проблеми з обробкою помилок скрипту. Чи можете ви додати деякі додаткові записи щодо кроку перетворення даних? Це може допомогти нам зневаджувати, якщо щось не так. » Ключовим тут є не лише * завдання * (додати ведення журналу), але і обґрунтування за ним — « потенційні проблеми з обробкою помилок » — і конкретна область, на якій варто зосередитися (« перетворення даних »). Зверніть увагу на ввічливий тон співпраці. Такий тип детального зворотного зв’ язку є неймовірно поширеним у професійному середовищі, і розуміння того, чому його запитують, так само важливо, як і виконання самого завдання.

windmill flow run --flow my_flow --script data_transformation.sh

(У цьому прикладі показано просту команду для виконання скрипту у Windmill, яка корисна для зневадження або тестування.)