All Darwinium configuration is stored and maintained within a dedicated Git repository.
The Workflows section of Portal contains a built in environment to edit files and folders in the repository.
Editor
The editing environment is an embedded Visual Studio Code environment, with:
- File and Folder explorer
- Source Control, via Git
- Terminal
- Extensions
The behaviour of Darwinium is defined through the folder here, as a Git repository (see Git Access).
Typical Folder Structure
├─ src
└── example.rules
└── example.feature.yaml
└── example.strategy
├─ journeys.yaml
├─ example.journey.yaml
├─ README.md
├─ dwn_ignore
└── ignoredfile.txt- src: any Darwinium signals, features and strategy files contained in this folder
- journeys.yaml: file that defines name of all live journeys
- example.journey.yaml: Darwinium journey file(s) for all those that are live
- README.md: Read me for repository
- dwn_ignore: Folder for reference and other files that should not be involved in the build process
Editing Files
A Darwinium principle is offering a way to edit configurations that has broad appeal across users.
The Darwinium Workflow environments comes with several in-built editors including:
- Text Editor: Basic text editor. Any file can be edited in this view (right-click file > Open With... > Text Editor)
- Darwinium Journey Assistant: Edit Darwinium journey files ( .journey.yaml ) to configure what runs on different steps
- Signals Editor: Edit Darwinium signal and model files (.rules)
- Features Editor: Edit Darwinium features files (.feature.yaml)
Users have three stages of power-user options for editing these types of files:
- Making use of the GUIs for interactive and drag and drop configuration
- Editing the files in the text editor, for efficencies such as copy/paste
- Using code based approaches (eg. Python) to automatically generate these files
Git Workflow
Any changes to the Darwinium repository is covered by git
The behaviour in production uses the configuration in the main branch at run-time.
Git is an industry standard for:
- Users working on changes concurrently
- Handling the merge process for different users changes
- Managing version control
- Automatic audit trail
Users can use Git via the embedded Visual Studio code interface or run commands directly in the Terminal.
It is recommended that users learn more about Git from online sources if unfamiliar with topics such as branching and merging.