From 4cacf2795dec32492abeb82faa4df2292752a2e1 Mon Sep 17 00:00:00 2001 From: Tjeerd Verschragen Date: Thu, 20 Aug 2026 10:50:24 +0200 Subject: [PATCH] Update the --force generator docs to back up before using it --- docs/workshops/example-orchestrator/generator.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/workshops/example-orchestrator/generator.md b/docs/workshops/example-orchestrator/generator.md index 257fc3a8..889babcd 100644 --- a/docs/workshops/example-orchestrator/generator.md +++ b/docs/workshops/example-orchestrator/generator.md @@ -144,15 +144,14 @@ python main.py generate workflows -cf templates/l2_p2p.yaml --no-dryrun As you can see this file needs to be run with the --force flag as it needs to overwrite a number of configuration files. Furthermore it will populate the files in `workflows/l2_p2p/`. Do that now: +!!! warning + If you modified any of the files that are going to be overwritten, commit them or back them up before forcefully + overwriting them with the generator and reapply the changes afterwards. + ```shell python main.py generate workflows -cf templates/l2_p2p.yaml --no-dryrun --force ``` -!!! warning - There is a [bug](https://github.com/workfloworchestrator/orchestrator-core/issues/1757) in `generate workflows` - which makes it overwrite the contents of `workflows/shared.py` instead of - extend it with the missing elements. You can use `git restore` to restore it aftwards. - Take a look around to see which files have been created by now. Can you explain what each of them are for?